Assinaturas

Atualizar Assinatura

PATCH/v1/subscriptions/:subscriptionId

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Autenticação

bearerAuthorizationstring · header · obrigatório

Envie no header:

Authorization: Bearer {{token}}

Path Parameters

Name	Type	Required	Description
subscriptionId	string	Required	Subscriptionid

Altera informações de uma assinatura ativa, como o plano contratado ou o dia de cobrança, sem precisar cancelar e recriar.

Atualizar assinatura (genérico)

Comportamento depende dos campos enviados. Este request cancela.

Campo	Obrig.	Tipo	Descrição
`action`	❌	string	`cancel`
`reason`	❌	string	Motivo
`old.itemId`	❌	string	Item a alterar (upgrade/downgrade)
`new.priceId`	❌	string	Novo preço
`new.quantity`	❌	number	Nova quantidade

Body

application/json

Content-Type:application/json

{
  "action": "cancel",
  "reason": "Cliente solicitou cancelamento"
}

Schema

Field	Type	Required	Description
action	string	-	-
reason	string	-	-

Headers

Name	Type	Value	Required
Content-Type	-	application/json	Optional

← Anterior

Buscar Assinatura

Atualizar Assinatura (Item)

const url = 'https://sandbox.validapay.com.br/v1/subscriptions/:subscriptionId';

const options = {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "action": "cancel",
  "reason": "Cliente solicitou cancelamento"
})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200 cancel

{
  "success": true,
  "status": "CANCELED",
  "reason": "Cliente solicitou cancelamento"
}

200200 upgrade

{
  "success": true,
  "type": "UPGRADE",
  "chargeId": "cha_xxx",
  "prorataAmount": 45.0
}

200200 downgrade

{
  "success": true,
  "type": "DOWNGRADE",
  "effectiveAt": "2024-02-01"
}

← Anterior

Buscar Assinatura

Atualizar Assinatura (Item)