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.