These docs are for v3. Click to read the latest docs for v5.

Objeto Plano

PropriedadeDescrição
objectStringNome do tipo do objeto criado/modificado.
Valor retornado: plan
id
Int
Número identificador do plano
amount
Int
Preço do plano, em centavos
days
Int
Período de dias entre uma cobrança e outra de uma assinatura atrelada. Ex: Para um plano mensal, o valor de days = 30.
name
String
Nome do plano
trial_days
Int
Dias que o usuário poderá testar o serviço gratuitamente
date_created
String
Data da criação do plano ISODate
payment_methods
String array
Array de Strings contendo os possíveis métodos de pagamento deste plano.
Valores possíveis: credit_card, boleto
charges
Int
Número de cobranças que devem ser feitas em uma assinatura.
  • *OBS:No caso de pagamento com cartão de crédito, esse valornã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.
installments
Int
Informa em quantas vezes o pagamento será parcelado para cada cobrança.
invoice_reminder
Int
Define em até quantos dias antes o cliente será avisado sobre o vencimento do boleto.