Atualizar item do plano
Altera nome, quantidade padrão, ordem, descrição e metadados do item. O valor não se muda por aqui.
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.
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.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
Authorizations
API Key da Credential (gerada no Backoffice)
Body
Novo nome do item.
1 - 255Nova quantidade padrão.
x > 0Nova ordem de exibição na consulta do plano.
x >= 0Nova descrição. Envie null para limpar.
1000Novo objeto de metadados.
Response
Item atualizado
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).