Alterar assinatura

put https://sandbox.api.assinaturas.pagseguro.com/subscriptions/{subscription_id}

time	status	user agent
Retrieving recent requests…

Loading…

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

subscription_id

string

required

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

Body Params

pro_rata

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.

next_invoice_at

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.

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

Responses

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://sandbox.api.assinaturas.pagseguro.com/subscriptions/subscription_id \
3
     --header 'Authorization: Bearer <token>' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

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

application/json

📘

📘Valor da assinatura

200200

400400

📘
Valor da assinatura