v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Subscriptions

List subscriptions

Lists the subscriptions of your organization for the live or test mode of the API key used, with their subscription items included. The list is paginated with cursors: use the Link response header or the starting_after and ending_before query parameters to navigate between pages.

get/subscriptions

Query parameters

ending_beforestring

A cursor to use in pagination. ending_before is a subscription ID that defines your place in the list. For example, if you make a list request and receive 30 subscriptions, starting with sub_bar, your subsequent call can include ending_before=sub_bar to fetch the previous page of the list.

limitinteger

Example:30

Maximum number of subscriptions to return per page. Ranges from 1 to 300. Defaults to 30.

starting_afterstring

A cursor to use in pagination. starting_after is a subscription ID that defines your place in the list. For example, if you make a list request and receive 30 subscriptions, ending with sub_foo, your subsequent call can include starting_after=sub_foo to fetch the next page of the list.

Response

List of subscriptions for the current mode, with their items included.

idstring required

Unique identifier of the subscription.

object'subscription' required

Type of the object. Always subscription.

billing_cycle_anchorstring date-time required

ISO 8601 timestamp that anchors the billing cycle. Fintoc sets this anchor to the subscription's creation time, or to trial_end when a trial applies. Fintoc measures every billing period from this anchor.

collection_method'charge_automatically' | 'send_invoice' required

Method Fintoc uses to collect the invoices the subscription generates. One of charge_automatically (Fintoc charges the saved payment method) or send_invoice (Fintoc sends the invoice for the customer to pay). Subscriptions created through the API always use send_invoice.

created_atstring date-time required

ISO 8601 timestamp of when the subscription was created.

customerstring required

ID of the customer the subscription bills.

metadataobject required

Set of key-value pairs attached to the subscription.

mode'live' | 'test' required

Mode of the object. One of live or test. test subscriptions use fake data for integration testing and do not collect real money.

payment_methodstring nullable required

ID of the payment method charged when collection_method is charge_automatically. Always null for subscriptions created through the API.

status'active' | 'canceled' | 'incomplete' | 'trialing' required

Current status of the subscription. One of active, incomplete (the first invoice payment has not yet succeeded), trialing (the trial period has not ended), or canceled (the subscription stopped generating invoices).

trial_endstring date-time nullable required

ISO 8601 timestamp at which the trial period ends, or null if the subscription has no trial.

Example response

[
  {
    "id": "sub_2c4mDcMaVxDx7nT3o5GbPMQbS2v",
    "billing_cycle_anchor": "2026-06-01T15:00:00Z",
    "collection_method": "send_invoice",
    "created_at": "2026-06-01T15:00:00Z",
    "customer": "cus_2c4mDe9NJyGmMzvCqLkXqAtjnRu",
    "items": [
      {
        "id": "si_2c4mDfkPLLrLTCJ3wPCEHGYpkVf",
        "price": {
          "currency": "CLP",
          "product": {
            "id": "prod_2c4mDgwQqkNwMHnXSc4DBjkbcWz",
            "created_at": "2026-06-01T15:00:00Z",
            "description": "Access to every premium feature.",
            "image_url": "https://example.com/image.png",
            "metadata": {
              "category": "saas"
            },
            "mode": "live",
            "name": "Premium plan"
          },
          "recurring": {
            "interval": "month",
            "interval_count": 1
          },
          "unit_amount": 10000
        },
        "quantity": 1
      }
    ],
    "metadata": {
      "order_id": "12345"
    },
    "mode": "live",
    "status": "active"
  }
]