Alterar plano

put https://sandbox.api.assinaturas.pagseguro.com/plans/{plan_id}

Utilize esse recurso para atualizar planos existentes com novas configurações. Todas as assinatura associadas serão afetadas.

🚧
Edição habilitada
Para que seja possível editar o plano, você deve ter configurado o parâmetro editable = true ao criar o plano. Do contrário, você não poderá editar esse plano.

🚧
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.

Path Params

plan_id

string

required

Identificador único do plano que deseja alterar. Formato PLAN_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.

Body Params

reference_id

string

Identificador único do plano na sua aplicação (Min 2; Max 65 caracteres). ⚠️Obrigatório⚠️

status

string

Define se o plano está ativo ou inativo.

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). ⚠️Obrigatório⚠️

amount

object

Objeto contendo as informações do valor a ser cobrado.

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_subscription

int32

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

payment_method

array of strings

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

Defaults to Bearer <token>

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
12
1
curl --request PUT \
2
     --url https://sandbox.api.assinaturas.pagseguro.com/plans/plan_id \
3
     --header 'Authorization: Bearer <token>' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "amount": {
9
    "currency": "BRL"
10
  }
11
}
12
'

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

application/json

Alterar plano

🚧
Edição habilitada

🚧
Planos diários

📘

🚧Edição habilitada

🚧Planos diários

📘

200200

400400

404404

🚧
Edição habilitada

🚧
Planos diários