Assinaturas

Cancelar Assinatura

DELETE/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

NameTypeRequiredDescription
subscriptionIdstringRequiredSubscriptionid

Cancela uma assinatura, interrompendo todas as cobranças futuras.

Cancelar assinatura

CampoObrig.Tipo
reasonstring

Body

application/json

Content-Type:application/json
{
  "reason": "Cliente solicitou"
}

Schema

FieldTypeRequiredDescription
reason
string-
-

Headers

NameTypeValueRequired
Content-Type-application/jsonOptional
const url = 'https://sandbox.validapay.com.br/v1/subscriptions/:subscriptionId';

const options = {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
};

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

Response Examples

200200
{
  "success": true,
  "message": "Assinatura cancelada com sucesso",
  "status": "CANCELED",
  "canceledCycles": 2
}
400400
{
  "code": "SUBSCRIPTION_ALREADY_CANCELED"
}
404404
{
  "code": "SUBSCRIPTION_NOT_FOUND"
}