v1
latestOpenAPI 3.1.02026-07-26477322.4 KBCriar plano
Este recurso possibilita a criação de um plan que poderá ser utilizado futuramente para a criação de uma assinatura. Para mais detalhes consulte a pagina principal do objeto.
Request body
Nome do plano. Max: 64 caracteres.
Descrição do plano.
Indica se o plano oferece entrega.
Meios de pagamento disponíveis para assinaturas criadas a partir do plano. <br>Valores possíveis: credit_card, boleto ou debit_card. Caso nenhum seja informado, o único meio de pagamento disponível por padrão será credit_card
Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.<br>Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista. O número de parcelas deverá ser 1 em recorrências.
Valor mínimo em centavos da fatura.
Texto exibido na fatura do cartão. <br>Será aplicado para assinaturas de cartão de crédito criadas a partir do plano. Max: 13 caracteres.
Moeda. Valores possíveis: BRL.
Frequência da recorrência. Valores possíveis: day,week, month ou year.
Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. <br>Ex.: plano mensal = interval_count (1) e interval (month) <br> plano trimestral = interval_count (3) e interval (month) <br> plano semestral = interval_count (6) e** interval** (month)
Dias de teste. A assinatura será iniciada após o término deste período.
Tipo de cobrança. Valores possíveis: prepaid, **postpaid **ou exact_day.
Dias disponíveis para cobrança das assinaturas criadas a partir do plano. Deve ser maior ou igual a 1 e menor ou igual a 28. Obrigatório, caso o billing_type seja igual a exact_day.
Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.<br>Saiba mais sobre metadata
Quantidade para o pricing_scheme.<br>Obrigatório quando o pricing_scheme.scheme_type for igual a unit.
Response
200