Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Retorna as informações completas de uma assinatura pelo seu ID.

​
Autenticação

Requer Customer Session Token no header Authorization: Bearer cst_xxx.

​
Requisição

​
id
string
required
ID da assinatura.
cURL
curl -X GET https://api.chargefy.io/api/v1/customer-portal/subscriptions/sub_123 \
  -H "Authorization: Bearer cst_xxx"

​
Resposta

​
id
string
Identificador único da assinatura.
​
status
string
Status da assinatura: active, canceled, past_due, trialing, unpaid.
​
current_period_start
string
Início do período de cobrança atual.
​
current_period_end
string
Fim do período de cobrança atual.
Resposta 200
{
  "id": "sub_123",
  "status": "active",
  "product": {
    "id": "prod_abc",
    "name": "Plano Pro",
    "description": "Acesso completo à plataforma"
  },
  "price": {
    "id": "price_xyz",
    "amount": 9900,
    "currency": "BRL",
    "recurring_interval": "month"
  },
  "current_period_start": "2025-07-01T00:00:00Z",
  "current_period_end": "2025-08-01T00:00:00Z",
  "cancel_at_period_end": false,
  "created_at": "2025-01-15T10:30:00Z"
}