Planos

O objeto plan representa um template pré-definido de assinatura, isto é, um plano, que facilita a criação de uma nova assinatura para um cliente. Saiba mais sobre planos acessando nossa documentação. O objeto plan possui os seguintes atributos:

AtributosTipoDescrição
idstringCódigo do plano. Formato: plan_XXXXXXXXXXXXXXXX.
namestringNome do plano.
descriptionstringDescrição do plano.
currencyenumMoeda. Valores possíveis: BRL, ARS, BOB, CLP, COP , MXN, PYG, USD , UYU e EUR.
intervalenumFrequência da recorrência. Valores possíveis: day,week, month ou year.
interval_countintegerNúmero de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. 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).
minimum_priceintegerValor mínimo em centavos da da assinatura.
billing_typeenumTipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.
billing_daysarray of integersDias disponíveis para cobrança das assinaturas criadas a partir do plano.
payment_methodsarray of stringsMeios de pagamento disponíveis para assinaturas criadas a partir do plano. Valores possíveis: credit_card, boleto ou cash.
installmentsarray of integersOpções de parcelamento disponíveis para assinaturas criadas a partir do plano. Disponível apenas caso o meio de pagamento da assinatura seja credit_card.
statement_descriptorstringTexto exibido na fatura do cartão.
trial_period_daysintegerNúmero de dias de trial. O cliente só será cobrado após esse período, quando a assinatura será iniciada.
statusenumStatus do plano. Valores possíveis: active, inactive ou deleted.
shippablebooleanIndica se o produto oferecido pelo plano é passível de entrega. Por exemplo, planos relacionados a serviços não possuem dados para entrega.
created_atdatetimeData de criação do plano.
updated_atdatetimeData de atualização do plano.
deleted_atdatetimeData de exclusão do plano.
itemsarray of objectsItens do plano.Saiba mais sobre itens do plano.
minimum_priceintValor mínimo do plano.
metadataobjectInformações adicionais sobre o plano. Saiba mais sobre metadata.
Website Localization