Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
plans

Cadastra um novo plano.

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

post/v1/plans

Request body

bodystring

JSON com atributos do novo 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 cadastrado 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