v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB

subscriptions

Retorna uma assinatura específica através do ID.

A assinatura é uma das entidades principais da plataforma e representa a relação entre um plano e um cliente. É a partir dela que faturas, cobranças e períodos são gerados.

Períodos

Toda assinatura possui obrigatoriamente um ou mais períodos de recorrência. Verifique a documentação do método GET subscriptions/{id}/periods para mais detalhes. Os períodos são gerados automaticamente pela plataforma.

Status

Status	Descrição
active	Assinatura ativa. O atributo current_period irá obrigatoriamente conter os dados do período atual.
future	Assinatura programada para uma data no futuro. Verifique o atributo start_at.
canceled	Assinatura cancelada.
expired	Assinatura encerrada. Este status ocorre apenas quando a assinatura possui duração limitada. Verifique o atributo billing_cycles.

Herança de atributos

Todos os atributos relacionados à periodicidade da assinatura e precificação dos produtos são herdados no momento da criação e não são atualizados automaticamente quando o plano de origem é alterado. Este comportamento existe para permitir que assinaturas usando mesmo plano possam utilizar condições de precificação diferentes. Ainda assim você pode realizar alterações em massa utilizando a API.

Descontos

Uma lista de descontos ativos será retornada no atributo discounts do objeto product_item. Caso você crie uma assinatura com cobrança imediata e um desconto temporário (cycles: 1), o mesmo será aplicado logo na primeira fatura e portanto não será mais considerado um desconto ativo.

get/v1/subscriptions/{id}

Path parameters

idinteger required

ID da assinatura que deverá ser retornada.

Response

Ok. Assinatura encontrada.

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.

v1