HomeGuiaAPI ReferenceNovidadesComunidade
API Reference

Alterar assinatura

Utilize esse recurso para atualizar as configurações de uma assinatura existente. Você pode aplicar cupons de desconto ou alterar a data do pagamento, por exemplo.

📘

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 da funcionalidade de assinaturas.

📘

Valor da assinatura

No momento de atualizar a assinatura, se você alterar o plano (plan.id) e também informar um valor para a assinatura (amount.value), o valor a ser cobrado do seu cliente será aquele informado em amount.value. Portanto, o valor associado ao plano informado (plan.id) será desconsiderado.

Path Params
string
required

Identificador único da assinatura que deseja alterar. Formato: SUBS_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.

Body Params
boolean

Define se a assinatura utilizar pró-rata ou não.

best_invoice_date
object

Objeto com a melhor data para próxima cobrança.

date

Melhor data para apenas a próxima cobrança, as demais voltarão ao ciclo normal.
Formato: YYY-MM-DD

amount
object

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

plan
object

Objeto contendo informações do plano que será usado na assinatura.

coupon
object

Objeto contendo informações do cupom de desconto, quando aplicável.

boolean

Define se o recurso de divisão de pagamento (split) será ativado para assinaturas. Quando definido como true, o split será aplicado conforme a configuração do objeto split.

split
object

Objeto que define as regras de divisão (percentual ou valor fixo) de uma transação recorrente (assinatura) entre até 15 recebedores.
⚠️ Obrigatório quando split_enabled for true.
🚫 Não deve ser enviado quando split_enabled for false ou não estiver presente.

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 64 caracteres).

Responses

Language
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