Alterar plano

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

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

🚧

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
string
required

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

Body Params
string

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

string

Define se o plano está ativo ou inativo.

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

amount
object

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

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

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
string
required
Defaults to Bearer <token>

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
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© 1996-2025 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

English
Powered by Localize
Português (Brasil)