v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB
Planos

Criar um novo plano

post/recurrence/plans/

Request body

intervalstring required

Frequência da recorrência. Valores possíveis: day, week, month ou year.

interval_countinteger required

Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1) e interval (month) plano trimestral = interval_count (3) e interval (month) plano semestral = interval_count (6) e interval (month)

namestring required

Nome do plano.

descriptionstring

Descrição do plano.

billing_typestring required

Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.

accepted_payment_methodsstring[] required

Métodos de pagamento aceito.

installmentsinteger

Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.

cancellation_grace_period_daysinteger

Número de dias em que a assinatura pode permanecer inativa antes de ser cancelada.

metadataobject nullable

Dados adicionais do plano.

Response

Plano criado com sucesso

plan_idstring required

Id do plano criado

intervalstring required

Frequência da recorrência.

interval_countinteger required

Número do intervalo definido

namestring required

Nome do plano criado.

statusstring

Status do plano criado

billing_typestring required

Tipo de cobrança criada.

installmentsinteger

Opções de parcelamento definidas para assinaturas criadas a partir do plano.

accepted_payment_methodsstring[] required

Meios de pagamento definidos para assinaturas criadas a partir do plano.

metadataobject nullable

Dados adicionais do plano.