Skip to main content
PATCH
Atualizar item do plano
PATCH /plans/:id/items/:itemId Faz parte do recurso Planos e Preços — o item, o preço versionado e os status estão lá. Atualização parcial: envie só os campos que quer alterar. A resposta é o item atualizado.
O valor cobrado não passa por aqui. Para mudar quanto o item custa, crie uma nova versão de preço — o preço é versionado justamente para que o reajuste não alcance quem já assinou. Alterar o valor no lugar reescreveria contratos fechados.
key e kind não são editáveis. A key é a referência estável do item, e mudá-la quebraria quem a usa; kind decide se a cobrança recorre ou acontece uma vez, e virar um no outro mudaria a natureza do que já foi contratado. Para trocar qualquer um dos dois, arquive o item e crie outro.
quantityDefault só vale para as assinaturas seguintes. É a quantidade com que o item nasce quando alguém assina — quem já assinou tem a sua quantidade gravada na assinatura, e ela não muda.
Plano arquivado não aceita edição de item. A rota responde 409. O item de um plano arquivado é somente leitura, como o plano.
metadata substitui, não mescla. O objeto enviado passa a ser o metadata inteiro. Para acrescentar uma chave, leia o objeto atual e envie-o completo com a nova.

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

Body

application/json
name
string

Novo nome do item.

Required string length: 1 - 255
quantityDefault
integer

Nova quantidade padrão.

Required range: x > 0
displayOrder
integer

Nova ordem de exibição na consulta do plano.

Required range: x >= 0
description
string | null

Nova descrição. Envie null para limpar.

Maximum string length: 1000
metadata
object

Novo objeto de metadados.

Response

Item atualizado

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).