Retorna as informações completas de uma assinatura pelo seu ID, incluindo dados do cliente, produto, desconto e faturas do gateway associadas.
Autenticação
Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization. Escopos necessários: web:read, web:write ou subscriptions:read.
Parâmetros de Path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
id | string | Sim | ID da assinatura |
Campos da Resposta
| Campo | Tipo | Descrição |
|---|
id | string | ID da assinatura |
status | string | Status: active, canceled, past_due, trialing, incomplete, incomplete_expired, unpaid |
customer_id | string | ID do cliente |
product_id | string | ID do produto |
product_price_id | string | null | ID do preço atual |
organization_id | string | ID da organização |
amount | number | Valor da assinatura em centavos |
currency | string | Moeda (ex: BRL) |
recurring_interval | string | Intervalo de recorrência: month ou year |
tax_exempted | boolean | Se a assinatura está isenta de impostos |
current_period_start | datetime | Início do período atual |
current_period_end | datetime | null | Fim do período atual |
cancel_at_period_end | boolean | Se será cancelada ao fim do período |
started_at | datetime | null | Data de ativação da assinatura |
ended_at | datetime | null | Data de encerramento definitivo |
canceled_at | datetime | null | Data em que o cancelamento foi solicitado |
trial_start | datetime | null | Início do período de trial |
trial_end | datetime | null | Fim do período de trial |
discount_id | string | null | ID do desconto aplicado |
checkout_id | string | null | ID do checkout de origem |
card_id | string | null | ID do cartão de cobrança vinculado |
card_data | object | null | Dados resumidos do cartão: card_brand, last4_digits, updated_at |
customer_cancellation_reason | string | null | Motivo do cancelamento informado pelo cliente |
customer_cancellation_comment | string | null | Comentário livre do cliente sobre o cancelamento |
user_metadata | object | null | Metadados personalizados do usuário |
zoop_subscription_id | string | null | ID da recorrência no gateway (campo da API) |
zoop_recurrence_plan_id | string | null | ID do plano de recorrência no gateway (campo da API) |
cross_sell | array | null | Add-ons do bundle snapshot originado no checkout (itens: product_id, product_price_id, quantity, amount_cents, name_snapshot) |
subscription_invoices | array | null | Cobranças avulsas e recorrentes, da mais recente para a mais antiga |
customer | object | null | Dados do cliente (id, email, name) |
product | object | null | Dados do produto (id, name, organization_id) |
discount | object | null | Dados do desconto (id, name, code) |
created_at | datetime | Data de criação |
modified_at | datetime | null | Data da última modificação |
Exemplo de Requisição
curl -X GET "https://api.chargefy.io/api/v1/subscriptions/sub_1a2b3c4d" \
-H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"
Exemplo de Resposta
{
"id": "sub_1a2b3c4d",
"status": "active",
"customer_id": "cus_9x8y7z",
"product_id": "prod_abc123",
"product_price_id": "price_def456",
"organization_id": "org_111222",
"amount": 4990,
"currency": "BRL",
"recurring_interval": "month",
"tax_exempted": false,
"current_period_start": "2026-03-01T00:00:00Z",
"current_period_end": "2026-04-01T00:00:00Z",
"cancel_at_period_end": false,
"started_at": "2026-01-15T10:30:00Z",
"ended_at": null,
"canceled_at": null,
"trial_start": null,
"trial_end": null,
"discount_id": null,
"card_id": "card_abc123",
"card_data": {
"card_brand": "Visa",
"last4_digits": "4242",
"updated_at": "2026-01-15T10:30:00Z"
},
"customer_cancellation_reason": null,
"customer_cancellation_comment": null,
"zoop_subscription_id": "gw_sub_xyz",
"subscription_invoices": [],
"customer": {
"id": "cus_9x8y7z",
"email": "[email protected]",
"name": "João Silva"
},
"product": {
"id": "prod_abc123",
"name": "Plano Pro"
},
"created_at": "2026-01-15T10:30:00Z",
"modified_at": "2026-03-01T00:00:00Z"
}
