Arquivar item do plano
Retira o item do catálogo. Quem já assinou continua sendo cobrado por ele.
DELETE /plans/:id/items/:itemId
Faz parte do recurso Planos e Preços — o item, o preço versionado e
os status estão lá.
Tira o item do plano. Ele deixa de aparecer em GET /plans/{id} e
não entra em nenhuma assinatura nova. A resposta é o item, já com deletedAt preenchido.
default não pode ser arquivado. É o item que sustenta o plano; sem ele não sobraria o
que cobrar. A rota responde 409.409 — no plano arquivado nada mais muda,
nem os itens.key volta a ficar livre. Arquivar é remoção lógica, e um item novo pode reusar a mesma
key depois. Ver Adicionar item.Exemplo
Authorizations
API Key da Credential (gerada no Backoffice)
Response
Item arquivado
Identificador único do registro.
ID do plano ao qual o registro pertence.
Chave única e legível (slug) do componente dentro do plano.
Nome de exibição do plano ou do componente.
Natureza da cobrança: recurring cobra a cada ciclo; activation cobra uma única vez, na fatura de adesão.
recurring, activation Quantidade padrão do componente ao instanciar a assinatura.
Ordem de exibição do componente na listagem do plano.
Descrição do item (item do plano ou linha da fatura).
Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
Data e hora de exclusão (soft delete); nulo se ativo.