Criar plano

post https://sandbox.api.assinaturas.pagseguro.com/plans

time	status	user agent
Retrieving recent requests…

Loading…

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

reference_id

string

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

name

string

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

description

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 ⚠️

setup_fee

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.

billing_cycles

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.

limit_subscriptions

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

Headers

Authorization

string

required

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

x-idempotency-key

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


xxxxxxxxxx
22
1
curl --request POST \
2
     --url https://sandbox.api.assinaturas.pagseguro.com/plans \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "amount": {
8
    "currency": "BRL"
9
  },
10
  "interval": {
11
    "unit": "MONTH",
12
    "length": 1
13
  },
14
  "trial": {
15
    "enabled": false,
16
    "hold_setup_fee": false
17
  },
18
  "payment_method": [
19
    "CREDIT_CARD"
20
  ]
21
}
22
'

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

application/json

🚧Planos diários

📘

200200

400400

🚧
Planos diários