Obter uma assinatura

Retorna o objeto subscription completo e atual. Use este endpoint quando você já tem o sub_* e precisa confirmar status, período atual, próxima cobrança, itens, trial, cancelamento agendado ou cobrança pausada antes de liberar acesso ou atualizar o estado local da assinatura. Para buscar assinaturas por customer, status, método de pagamento ou janela de criação, use Listar Assinaturas.

string

required

ID da subscription (sub_*).

curl -X GET "https://api.chargefy.io/v1/subscriptions/sub_H7oDYZhqTvNDUJbM" \
  -H "Authorization: Bearer {{API_KEY}}"

200

{
  "id": "sub_H7oDYZhqTvNDUJbM",
  "object": "subscription",
  "billing_cycle_anchor": "2026-05-19T18:00:00Z",
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": null,
  "cancellation_details": {
    "comment": null,
    "feedback": null,
    "reason": null
  },
  "collection_method": "charge_automatically",
  "created_at": "2026-05-19T18:00:00Z",
  "currency": "brl",
  "current_period_end": "2026-06-19T18:00:00Z",
  "current_period_start": "2026-05-19T18:00:00Z",
  "customer": "cus_WN4LibNoJA431dRX",
  "days_until_due": null,
  "default_payment_method": "pm_q89ZLf2ML3ePU5jq",
  "discount": null,
  "ended_at": null,
  "installments": 1,
  "items": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/subscription-items?subscription=sub_H7oDYZhqTvNDUJbM"
  },
  "latest_invoice": "inv_jonGvWskQqLyLt1D",
  "livemode": true,
  "metadata": {},
  "next_billing_at": "2026-06-19T18:00:00Z",
  "pause_collection": null,
  "payment_settings": {},
  "pending_setup_intent": null,
  "pending_update": null,
  "resumed_at": null,
  "schedule": null,
  "schedule_phase_index": null,
  "start_date": "2026-05-19T18:00:00Z",
  "status": "active",
  "trial_end": null,
  "trial_settings": {
    "end_behavior": {
      "missing_payment_method": "create_invoice"
    }
  },
  "trial_start": null,
  "updated_at": "2026-05-19T18:01:02Z"
}

Campos para observar

Campo	Por que importa
`status`	Estado canônico da assinatura: `trialing`, `active`, `past_due`, `unpaid`, `paused`, `canceled` e outros.
`current_period_start` / `current_period_end`	Intervalo do ciclo que está valendo agora.
`next_billing_at`	Próximo momento em que a assinatura deve gerar ou cobrar o ciclo seguinte.
`latest_invoice`	Fatura mais recente ligada à assinatura. Use para conciliação financeira.
`items.data[]`	Itens, preços e quantidades que compõem a cobrança recorrente.
`cancel_at_period_end` / `cancel_at`	Indica cancelamento agendado sem encerrar imediatamente o ciclo atual.
`pause_collection`	Configuração de pausa de cobrança, quando existir, sem necessariamente pausar o ciclo da assinatura.
`pending_update`	Alteração agendada ou pendente que ainda não foi aplicada.

Erros comuns

404

{
  "error": {
    "code": "resource_missing",
    "message": "Subscription not found",
    "type": "invalid_request_error"
  }
}

401

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Obter uma assinatura

Campos para observar

Erros comuns

​Campos para observar

​Erros comuns

Campos para observar

Erros comuns