Skip to main content
PATCH
Atualizar plano
PATCH /plans/:id Faz parte do recurso Planos e Preços — o conceito e os status estão lá. Atualização parcial: envie só os campos que quer alterar. A resposta é o plano atualizado, na mesma forma de GET /plans/{id}.
O que a rota altera é a apresentação do plano, não o que ele cobra. Valor, cadência, período de teste e code não passam por aqui:
  • valor — crie uma nova versão de preço. O preço é versionado justamente para que reajustar não mexa em quem já assinou;
  • itensadicione ou arquive um item;
  • cadência, teste e code — não são editáveis. Assinaturas em curso dependem deles, e mudá-los reescreveria contratos já fechados. Publique um plano novo.
Plano arquivado não aceita edição. A rota responde 409: arquivar é terminal, e o registro passa a ser somente leitura.
metadata substitui, não mescla. O objeto enviado passa a ser o metadata inteiro — enviar {"plano":"pro"} num plano que tinha {"origem":"site"} apaga a chave anterior. 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

id
string
required

ID do plano

Body

application/json
name
string

Novo nome do plano.

Required string length: 1 - 255
description
string | null

Nova descrição. Envie null para limpar.

Maximum string length: 1000
metadata
object

Novo objeto de metadados — substitui o anterior.

Response

Plano atualizado

id
string

Identificador único do registro.

code
string

Código de identificação do recurso (ex.: código do plano ou do contrato).

name
string

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

description
string | null

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

status
string

Status atual do registro (assinatura, fatura, plano ou slip de pagamento).

recurrence
object | null

Cadência da cobrança: a cada quantas unidades (interval), qual unidade (unit), a âncora do ciclo e se cobra no início ou no fim. Vale para todos os itens recorrentes.

trialSpec
object | null

Período de teste padrão da oferta. A assinatura pode sobrescrevê-lo.

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