Skip to main content
DELETE
Arquivar item do plano
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.
Isto não interrompe cobrança nenhuma. As assinaturas que já incluíam o item continuam sendo faturadas por ele, no preço que contrataram — a rota mexe no catálogo, não nos contratos. Não há aviso nem bloqueio se existirem assinaturas ativas cobrando o item: para parar de cobrar alguém, o caminho é a própria assinatura.
O item default não pode ser arquivado. É o item que sustenta o plano; sem ele não sobraria o que cobrar. A rota responde 409.
Plano arquivado não aceita a operação. Responde 409 — no plano arquivado nada mais muda, nem os itens.
A key volta a ficar livre. Arquivar é remoção lógica, e um item novo pode reusar a mesma key depois. Ver Adicionar item.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

itemId
string
required

ID do item do plano

id
string
required

ID do plano

Response

Item arquivado

id
string

Identificador único do registro.

planId
string

ID do plano ao qual o registro pertence.

key
string

Chave única e legível (slug) do componente dentro do plano.

name
string

Nome de exibição do plano ou do componente.

kind
enum<string>

Natureza da cobrança: recurring cobra a cada ciclo; activation cobra uma única vez, na fatura de adesão.

Available options:
recurring,
activation
quantityDefault
integer

Quantidade padrão do componente ao instanciar a assinatura.

displayOrder
integer

Ordem de exibição do componente na listagem do plano.

description
string | null

Descrição do item (item do plano ou linha da fatura).

metadata
object

Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).

deletedAt
string<date-time> | null

Data e hora de exclusão (soft delete); nulo se ativo.