O objeto subscription é uma recorrência em si, que possibilita a cobrança do clientes com intervalos pré determinados, sem que seja necessário criar essa regra de negócio do seu lado. O objeto subscription contêm os seguintes atributos:
| Atributos | Tipo | Descrição |
|---|---|---|
id | string | Código da assinatura. Formato: sub_XXXXXXXXXXXXXXXX. |
payment_method | string | Meio de pagamento. Valores possíveis: credit_card, boleto, cash ou debit_card. |
currency | string | Moeda. Valor possível: BRL. |
start_at | datetime | Data de início da assinatura. |
interval | string | Intervalo da recorrência. Valores possíveis: day, week, month ou year. |
interval_count | string | Repetições do intervalo da recorrência. 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). |
billing_type | string | Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day. |
billing_day | integer | Dia da cobrança. Obrigatório, caso o billing_type seja exact_day. |
current_period | object | Período atual da assinatura. |
next_billing_at | datetime | Data da próxima cobrança. |
installments | integer | Quantidade de parcelas. Será aplicada caso o método de pagamento da assinatura seja cartão de crédito . |
statement_descriptor | integer | Texto exibido na fatura do cartão. |
customer | object | Dados do cliente. Saiba mais sobre clientes |
card | object | Dados do cartão de crédito. Saiba mais sobre cartões |
plan | object | Dados do plano. Saiba mais sobre planos |
discounts | array of objects | Descontos. |
increments | array of objects | Incrementos. |
minimum_price | integer | Valor mínimo, em centavos, da assinatura. |
items | array of objects | Itens da assinatura. Saiba mais sobre itens da assinatura |
status | string | Status da assinatura. Valores possíveis: active, canceled ou future. |
created_at | datetime | Data de criação da assinatura. |
updated_at | datetime | Data de atualização da assinatura. |
canceled_at | datetime | Data de cancelamento da assinatura. |
metadata | object | Objeto chave/valor utilizado para armazenar informações adicionais sobre o assinatura. Saiba mais sobre metadata. |
gateway_affiliation_id | string | Código da afiliação no gateway. |
Formas de Pagamento de Assinaturas
Podemos criar uma assinatura com os dois meios de pagamento distintos:
credit_cardouboleto. Caso utilizecredit_cardserá necessário o envio docarddentro da requisição juntamente dopayment_method. Já no caso doboletosomente será necessário opayment_method.