Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
plans

Atualiza um plano existente.

Verifique documentação dos atributos no método GET plans/{id}.

Atualizando produtos relacionados

A lista de produtos relacionados à um plano é representado pelo array plan_items.

  • Para atualizar um objeto existente no array plan_items, simplesmente indique seu ID e os novos atributos.
  • Para criar um novo objeto, informe apenas os atributos sem o ID.
  • Para remover um objeto existente, inclua o atributo "_destroy": "1", sem esquecer de informar o ID.

Além disso é possível omitir o parâmetro plan_items na requisição para não atualizar os produtos relacionados.

put/v1/plans/{id}

Path parameters

idinteger required

ID do plano que deverá ser atualizado.

Request body

bodystring

JSON com os novos atributos do plano.

namestring required

Nome do plano

interval'days' | 'months' required

Duração do intervalo

interval_countinteger required

Número de intervalos dentro de um período

billing_trigger_type'beginning_of_period' | 'end_of_period' | 'day_of_month' required

Referência para data de geração da cobrança

billing_trigger_dayinteger required

Dia para geração da cobrança

billing_cyclesinteger

Número máximo de períodos em uma assinatura. Nulo significa duração indefinida

codestring

Código externo para referência via API

descriptionstring

Descrição interna do plano

installmentsinteger

Número de parcelas. Se não for informado, o valor '1' será utilizado

invoice_splitstring

Nota fiscal fracionada

status'active' | 'inactive' | 'deleted'

Status do plano

metadata'array'

Metadados do plano

Response

Plano atualizado com sucesso.

idinteger required

ID do plano

namestring required

Nome do plano

interval'days' | 'months' required

Duração do intervalo

interval_countinteger required

Número de intervalos dentro de um período

billing_trigger_type'beginning_of_period' | 'end_of_period' | 'day_of_month' required

Referência para data de geração da cobrança

billing_trigger_dayinteger required

Dia para geração da cobrança

billing_cyclesinteger

Número máximo de períodos em uma assinatura. Nulo significa duração indefinida

codestring

Código externo para referência via API

descriptionstring

Descrição interna do plano

status'active' | 'inactive' | 'deleted' required

Status do plano

installmentsinteger required

Número de parcelas

invoice_splitstring required

Nota fiscal fracionada

interval_namestring required

Nome do intervalo do plano gerado automaticamente a partir dos parâmetros de duração

created_atstring required

Data e hora do cadastro do plano

updated_atstring required

Data e hora da última atualização do plano

metadataobject

Metadados do plano