Sign in

v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB
Assinaturas

Incluir item em uma assinatura

post/recurrence/subscriptions/{subscription_id}/items

Path parameters

subscription_idstring required

Request body

product_idstring required

Id do produto.

descriptionstring

Descrição do produto

typestring

Tipo do produto

statusstring

Status do item

metadataobject

Dados adicionais do produto

Response

Assinatura criada com sucesso

subscription_idstring required

Id da assinatura.

payment_methodstring required

Meio de pagamento utilizado na assinatura.

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)

plan_idstring nullable

Id do plano assinado.

billing_typestring required
next_billing_atstring date-time

Data do próximo faturamento da assinatura.

installmentsinteger nullable

Quantidade de parcelas aplicádas ao cartão de crédito.

external_idstring nullable

Id externo.

statusstring
created_atstring date-time required

Data de criação da assinatura.

updated_atstring date-time required

Data de atualização da assinatura.

metadataobject nullable

Dados adicionais da assinatura.