v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Subscription Payment

List cycles on a subscription

Returns the cycles attached to a subscription, ordered from newest to oldest. Use status[] to narrow the result set — values are case-insensitive. Pagination is cursor-based: pass the previous response's metadata.next_cursor back as cursor. An empty next_cursor means there are no further pages.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">subscription:read</code>

get/subscription/{id}/cycle

Path parameters

idstring uuid required

UUID of the subscription whose cycles you want to list.

Query parameters

limitinteger
Example:10

Maximum number of cycles to return. Defaults to 50, capped at 100.

cursorstring
Example:lL_j7ilk7rc

Opaque cursor from the previous response's metadata.next_cursor. Omit on the first call.

statusstring[]

Filter by one or more statuses. Repeat the parameter for multiple values (e.g. status[]=pending&status[]=failed). Case-insensitive.

[
  "PENDING",
  "FAILED"
]

Response

OK

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "RENEWABLE",
      "status": "PENDING",
      "value": 10.5,
      "capture_at": "2026-05-22T09:00:00Z",
      "description": "monthly charge",
      "key": "my-key"
    }
  ],
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 10
  }
}