❗️
Atenção: Essa versão de API será descontinuada
Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.
No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.
Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.
Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para relacionamento@pagar.me e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

Propriedade	Descrição
object `String`	Nome do tipo do objeto criado/modificado. Valor retornado: plan
id `Int`	Número identificador do plano
amount `Int`	Preço do plano, em centavos
days `Int`	Período de dias entre uma cobrança e outra de uma assinatura atrelada. Ex: Para um plano mensal, o valor de days = 30.
name `String`	Nome do plano
trial_days `Int`	Dias que o usuário poderá testar o serviço gratuitamente
date_created `String`	Data da criação do plano ISODate
payment_methods `String array`	Array de Strings contendo os possíveis métodos de pagamento deste plano. Valores possíveis: credit_card, boleto
charges `Int`	Número de cobranças que devem ser feitas em uma assinatura. OBS:No caso de pagamento com cartão de crédito, esse valornão inclui a cobrança feita na criação da assinatura. Ex: Plano anual com no máximo 3 cobranças, days = 365 e charges = 2 (cartão de crédito) ou charges = 3 (boleto) OBS²**: Caso queira cobrar o plano indefinidamente, não é preciso passar este campo na criação do plano.
installments `Int`	Informa em quantas vezes o pagamento será parcelado para cada cobrança.
invoice_reminder `Int`	Define em até quantos dias antes o cliente será avisado sobre o vencimento do boleto.