Listar assinaturas

Lista subscriptions em ordem decrescente de criação. Por padrão, subscriptions canceladas não aparecem; envie status=canceled ou status=all para incluí-las.

string

Filtra pelo customer (cus_*).

string

Filtra pelo payment method padrão (pm_*).

string

Filtra por status: incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused ou all (inclui canceladas). O significado de cada status está no objeto Subscription.

string

Filtra subscriptions criadas a partir de uma data ISO 8601.

string

Filtra subscriptions criadas depois de uma data ISO 8601.

string

Filtra subscriptions criadas até uma data ISO 8601, inclusive.

string

Filtra subscriptions criadas antes de uma data ISO 8601.

integer

Quantidade de itens, de 1 a 100.

string

Cursor para a próxima página.

string

Cursor para a página anterior.

curl -X GET "https://api.chargefy.io/v1/subscriptions?customer=cus_zQAzwBL4a2vaPSR4&limit=10" \
  -H "Authorization: Bearer {{API_KEY}}"

200

{
  "object": "list",
  "data": [
    {
      "id": "sub_D9vpoEEBMDK667HY",
      "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_zQAzwBL4a2vaPSR4",
      "days_until_due": null,
      "default_payment_method": "pm_M5PvR8F4a1VwjAT2",
      "discount": null,
      "ended_at": null,
      "installments": 1,
      "items": {
        "object": "list",
        "data": [
          {
            "id": "si_ZNZHCAtAQ33czDdu",
            "object": "subscription_item",
            "aggregate_usage": "sum",
            "amount_discount": 0,
            "amount_subtotal": 9990,
            "amount_tax": 0,
            "amount_total": 9990,
            "created_at": "2026-05-19T18:00:00Z",
            "currency": "brl",
            "discount": null,
            "metadata": {},
            "position": 0,
            "price": "price_rdsYwj6L4DPrtuxb",
            "price_data": null,
            "product": "prod_s1NUAJejia3crnoT",
            "quantity": 1,
            "recurring": {
              "interval": "month",
              "interval_count": 1
            },
            "subscription": "sub_D9vpoEEBMDK667HY",
            "unit_amount": 9990,
            "updated_at": null,
            "usage_period_end": null,
            "usage_period_start": null,
            "usage_type": "licensed"
          }
        ],
        "has_more": false,
        "url": "/v1/subscription-items?subscription=sub_D9vpoEEBMDK667HY"
      },
      "latest_invoice": "inv_uKUEDrxQM88iPCHN",
      "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"
    }
  ],
  "has_more": false,
  "url": "/v1/subscriptions"
}

Erros comuns

400

{
  "error": {
    "code": "invalid_request",
    "message": "limit must be between 1 and 100.",
    "param": "limit",
    "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

Listar assinaturas

Erros comuns

​Erros comuns

Erros comuns