v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
subscriptions

Cancela uma assinatura através do ID.

delete/v1/subscriptions/{id}

Path parameters

idinteger required

ID da assinatura a ser cancelada.

Query parameters

cancel_billsstring

Indica se faturas pendentes da assinatura também devem ser canceladas. Default: true

commentsstring

Comentários opcionais sobre o cancelamento.

Response

Assinatura cancelada com sucesso.

idinteger required

ID da assinatura

status'active' | 'canceled' | 'future' | 'expired' required

Status da assinatura

start_atstring required

Data do início da assinatura no formato ISO 8601

end_atstring

Data do término da assinatura no formato ISO 8601

next_billing_atstring

Data da próxima cobrança da assinatura

overdue_sincestring

Data do início da inadimplência

codestring

Código externo para referência via API

cancel_atstring

Data do cancelamento da assinatura

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 da assinatura. Nulo significa duração indefinida

installmentsinteger required

Número de parcelas

created_atstring required

Data e hora do cadastro da assinatura

updated_atstring required

Data e hora da última atualização da assinatura

metadataobject

Metadados da assinatura

invoice_splitstring

Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano.