Assinaturas

Buscar Assinatura

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

Retorna os detalhes completos de uma assinatura, incluindo o ciclo atual, a data da próxima cobrança e o histórico de pagamentos.

Consultar assinatura

Retorna customer, items, upgrades, billingCycles, coupon.

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

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

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

Response Examples

200200
{
  "subscriptionId": "sub_xxx",
  "status": "ACTIVE",
  "customer": {},
  "items": [],
  "upgrades": [],
  "billingCycles": [],
  "coupon": null
}
404404
{
  "code": "SUBSCRIPTION_NOT_FOUND"
}