HomeGuiaAPI ReferenceNovidadesComunidade
API Reference

Criar plano

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Utilize esse recurso para criar novos planos. Os planos são pré-requisitos para a criação de assinaturas.

🚧

Planos diários

Planos diários não aceitam boleto como forma de pagamento.

📘

Acesse o guia do serviço de Pagamentos Recorrentes para mais informações sobre seu funcionamento e funcionalidades disponíveis.

Você também pode consultar o guia específico de planos.

Body Params
string

Identificador único atribuído para o plano. Utilizado internamente pelo vendedor em seu sistema (Max 65 caracteres).

string

Nome do plano na sua aplicação (Max 65 caracteres). ⚠️ Obrigatório ⚠️

string

Descrição do plano na sua aplicação (Max 250 caracteres).

amount
object

Objeto contendo as informações do valor a ser cobrado. ⚠️ Obrigatório ⚠️

int32

Taxa de contratação a ser cobrada na assinatura especificada em centavos de Real. Se não desejar cobrar uma taxa de contratação para o plano, o campo setup_fee deve ser deixado em branco ou não enviado como atributo (Max 9 caracteres).

interval
object

Objeto contendo os detalhes de intervalo de tempo das cobranças.

int32

Quantidade de ciclos (faturas) que a assinatura terá até expirar. Não informar este campo para que não haja expiração.

trial
object

Objeto contendo as informações do período de teste/trial.

int32

Quantidade máxima de assinaturas do plano. Para não haver limite, deixar esse campo em branco.

payment_method
array of strings
Defaults to CREDIT_CARD

Formas de pagamentos aceitas no plano. Caso o atributo não seja informado, a forma de pagamento default é CREDIT_CARD.
Exemplos: BOLETO, CREDIT_CARD.

payment_method
boolean
Defaults to true

Sinaliza se o plano criado poderá ser alterado após a criação. Por padrão, esse parâmetro é considerado true.

Headers
string
required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

string

Chave composta de caracteres alfanumérico, exceto caracteres especiais. As chaves são recicladas depois de um intervalo não específico. Com isso, é garantido sua eficiência por 48 horas (MAX 200 caracteres).

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© 1996- Todos os direitos reservados.

PAGSEGURO INTERNET INSTITUIÇÃO DE PAGAMENTO S/A - CNPJ/MF 08.561.701/0001-01

Av. Brigadeiro Faria Lima, 1.384, São Paulo - SP - CEP 01451-001