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, 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âmetroTipoObrigatórioDescrição
idstringSimID da assinatura

​
Campos da Resposta

CampoTipoDescrição
idstringID da assinatura
statusstringStatus: active, canceled, past_due, trialing, incomplete, incomplete_expired, unpaid
customer_idstringID do cliente
product_idstringID do produto
product_price_idstring | nullID do preço atual
organization_idstringID da organização
amountnumberValor da assinatura em centavos
currencystringMoeda (ex: BRL)
recurring_intervalstringIntervalo de recorrência: month ou year
tax_exemptedbooleanSe a assinatura está isenta de impostos
current_period_startdatetimeInício do período atual
current_period_enddatetime | nullFim do período atual
cancel_at_period_endbooleanSe será cancelada ao fim do período
started_atdatetime | nullData de ativação da assinatura
ended_atdatetime | nullData de encerramento definitivo
canceled_atdatetime | nullData em que o cancelamento foi solicitado
trial_startdatetime | nullInício do período de trial
trial_enddatetime | nullFim do período de trial
discount_idstring | nullID do desconto aplicado
checkout_idstring | nullID do checkout de origem
card_idstring | nullID do cartão de cobrança vinculado
card_dataobject | nullDados resumidos do cartão: card_brand, last4_digits, updated_at
customer_cancellation_reasonstring | nullMotivo do cancelamento informado pelo cliente
customer_cancellation_commentstring | nullComentário livre do cliente sobre o cancelamento
user_metadataobject | nullMetadados personalizados do usuário
zoop_subscription_idstring | nullID da recorrência no gateway (campo da API)
zoop_recurrence_plan_idstring | nullID do plano de recorrência no gateway (campo da API)
subscription_invoicesarray | nullCobranças avulsas e recorrentes, da mais recente para a mais antiga
customerobject | nullDados do cliente (id, email, name)
productobject | nullDados do produto (id, name, organization_id)
discountobject | nullDados do desconto (id, name, code)
created_atdatetimeData de criação
modified_atdatetime | nullData 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": "cliente@exemplo.com",
    "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"
}