Criar plano

post

https://api.pagar.me/core/v5/plans

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Nome do plano. Max: 64 caracteres.

description

string

Descrição do plano.

shippable

boolean

Indica se o plano oferece entrega.

payment_methods

array of strings

Meios de pagamento disponíveis para assinaturas criadas a partir do plano.
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

payment_methods

installments

array of int32s

Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.
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.

installments

minimum_price

int32

Valor mínimo em centavos da fatura.

statement_descriptor

string

Texto exibido na fatura do cartão.
Será aplicado para assinaturas de cartão de crédito criadas a partir do plano. Max: 13 caracteres.

currency

string

Moeda. Valores possíveis: BRL.

interval

string

Defaults to month

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

interval_count

int32

Defaults to 1

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)

trial_period_days

int32

Dias de teste. A assinatura será iniciada após o término deste período.

billing_type

string

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

billing_days

array of int32s

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.

billing_days

items

array of objects

Itens do plano. Saiba mais sobre um itens do plano

items

metadata

string

Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.
Saiba mais sobre metadata

pricing_scheme

object

Esquema de precificação.
Obrigatório na ausência de items.

quantity

int32

Defaults to null

Quantidade para o pricing_scheme.
Obrigatório quando o pricing_scheme.scheme_type for igual a unit.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

422422