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

Criando Planos

post

https://api.pagar.me/1/plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

int32

required

Defaults to 4990

Valor que será cobrado recorrentemente (em centavos). Ex: R$49,90 = 4990

days

string

required

Defaults to 30

Prazo, em dias, para cobrança das parcelas

name

string

required

Nome do plano

trial_days

int32

Defaults to 0

default: 0 Dias para teste gratuito do produto. Valor começará a ser cobrado no dia trial_days + 1

payment_methods

array of strings

Meios de pagamentos aceitos. Pode ser "boleto", "credit_card" ou ambos

payment_methods

color

string

Defaults to #cacaca

Armazena o valor de uma cor para o plano

charges

string

Número de cobranças que poderão ser feitas nesse plano. Ex: Plano cobrado 1x por ano, válido por no máximo 3 anos. Nesse caso, nossos parâmetros serão: days = 365, installments = 1, charges=2 (cartão de crédito) ou charges=3 (boleto). OBS: No caso de cartão de crédito, a cobrança feita na ativação da assinatura não é considerada. OBS: null irá cobrar o usuário indefinidamente, ou até o plano ser cancelado

installments

string

Número de parcelas entre cada cobrança (charges). Ex: Plano anual, válido por 2 anos, sendo que cada transação será dividida em 12 vezes. Nesse caso, nossos parâmetros serão: days = 365, installments = 12, charges=2 (cartão de crédito) ou charges=3 (boleto). OBS: Boleto sempre terá installments = 1

invoice_reminder

int32

Define em até quantos dias antes o cliente será avisado sobre o vencimento do boleto.

Response

Language

Credentials

Query

Loading…

Response

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

application/json

Transaction IDs

200200