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 |
---|---|---|
| string | Código da assinatura. Formato: |
| string | Meio de pagamento. Valores possíveis: |
| string | Moeda. Valor possível: |
| datetime | Data de início da assinatura. |
| string | Intervalo da recorrência. Valores possíveis: |
| 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). |
| string | Tipo de cobrança. Valores possíveis: |
| integer | Dia da cobrança. Obrigatório, caso o |
| object | Período atual da assinatura. |
| datetime | Data da próxima cobrança. |
| integer | Quantidade de parcelas. Será aplicada caso o método de pagamento da assinatura seja cartão de crédito . |
| integer | Texto exibido na fatura do cartão. |
| object | Dados do cliente. Saiba mais sobre clientes |
| object | Dados do cartão de crédito. Saiba mais sobre cartões |
| object | Dados do plano. Saiba mais sobre planos |
| array of objects | Descontos. |
| array of objects | Incrementos. |
| integer | Valor mínimo, em centavos, da assinatura. |
| array of objects | Itens da assinatura. Saiba mais sobre itens da assinatura |
| string | Status da assinatura. Valores possíveis: |
| datetime | Data de criação da assinatura. |
| datetime | Data de atualização da assinatura. |
| datetime | Data de cancelamento da assinatura. |
| object | Objeto chave/valor utilizado para armazenar informações adicionais sobre o assinatura. Saiba mais sobre metadata. |
| string | Código da afiliação no gateway. |
| object | Split na assinatura. |
Formas de Pagamento de Assinaturas
Podemos criar uma assinatura com os dois meios de pagamento distintos:
credit_card
ouboleto
. Caso utilizecredit_card
será necessário o envio docard
dentro da requisição juntamente dopayment_method
. Já no caso doboleto
somente será necessário opayment_method
.