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:

Atributos

Tipo

Descrição

id

string

Código do plano. Formato: plan_XXXXXXXXXXXXXXXX.

name

string

Nome do plano.

description

string

Descrição do plano.

currency

enum

Moeda. Valores possíveis: BRL.

interval

enum

Frequência da recorrência. Valores possíveis: day,week, month ou year.

interval_count

integer

Nú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_price

integer

Valor mínimo em centavos da assinatura.

billing_type

enum

Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.

billing_days

array of integers

Dias disponíveis para cobrança das assinaturas criadas a partir do plano.

payment_methods

array of strings

Meios de pagamento disponíveis para assinaturas criadas a partir do plano. Valores possíveis: credit_card, boleto ou cash.

installments

array of integers

Opçõ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_descriptor

string

Texto exibido na fatura do cartão.

trial_period_days

integer

Número de dias de trial. O cliente só será cobrado após esse período, quando a assinatura será iniciada.

status

enum

Status do plano. Valores possíveis: active, inactive ou deleted.

shippable

boolean

Indica se o produto oferecido pelo plano é passível de entrega. Por exemplo, planos relacionados a serviços não possuem dados para entrega.

created_at

datetime

Data de criação do plano.

updated_at

datetime

Data de atualização do plano.

deleted_at

datetime

Data de exclusão do plano.

items

array of objects

Itens do plano.Saiba mais sobre itens do plano.

metadata

object

Informações adicionais sobre o plano. Saiba mais sobre metadata.