Assinaturas

Buscar Assinatura

Retorna os detalhes completos de uma assinatura específica.

A resposta inclui: customer (dados do cliente), items (itens da assinatura), upgrades (mudanças de plano pendentes), billingCycles (histórico de ciclos) e coupon (cupom aplicado, se houver).

Case de uso:

Como SaaS, quero consultar o status e os itens de uma assinatura específica para exibir na área do cliente.

GET/v1/subscriptions/:subscriptionId

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

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

Authorizations

bearer

Authorization

string · header · required

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

subscriptions/read

Path Parameters

Name	Type	Required	Description
subscriptionId	string	Required	ID da assinatura (ex: sub_xxx) - required

← Anterior

Listar Assinaturas

Atualizar Assinatura (Item)

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

{
    "error": {
        "message": "Assinatura não encontrada",
        "code": "SUBSCRIPTION_NOT_FOUND",
        "details": null,
        "timestamp": "2026-07-14T21:39:36.322Z"
    }
}

← Anterior

Listar Assinaturas

Atualizar Assinatura (Item)