Representa uma configuração de recorrência a qual um cliente consegue assinar.
É a entidade que define o preço, nome e periodicidade da recorrência
Propriedade | Descrição |
---|---|
objectString | Nome do tipo do objeto criado/modificado. Valor retornado: plan |
idInt | Número identificador do plano |
amountInt | Preço do plano, em centavos |
daysInt | Período de dias entre uma cobrança e outra de uma assinatura atrelada. Ex: Para um plano mensal, o valor de days = 30. |
nameString | Nome do plano |
trial_daysInt | Dias que o usuário poderá testar o serviço gratuitamente |
date_createdString | Data da criação do plano ISODate |
payment_methodsString array | Array de Strings contendo os possíveis métodos de pagamento deste plano. Valores possíveis: credit_card, boleto |
chargesInt | Número de cobranças que devem ser feitas em uma assinatura. OBS: No caso de pagamento com cartão de crédito, esse valor não inclui a cobrança feita na criação da assinatura. Ex: Plano anual com no máximo 3 cobranças, days = 365 e charges = 2 (cartão de crédito) ou charges = 3 (boleto) OBS2: Caso queira cobrar o plano indefinidamente, não é preciso passar este campo na criação do plano. |
installmentsInt | Informa em quantas vezes o pagamento será parcelado para cada cobrança. |
invoice_reminderInt | Define em até quantos dias antes o cliente será avisado sobre o vencimento do boleto. |