Subscriptions

List subscriptions

curl "https://api.subscriby.net/v1/subscriptions?status=active" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

The held subscriptions across every project the token reaches, newest first, paged with page and per_page (default 25; limit is accepted as an alias). status matches a single payment status and plan_id scopes to one plan. Rows carry no grants.

A token minted with scope:project:<uuid> entries lists only the subscriptions of those projects, and a subscription of any other project is 404 RESOURCE_NOT_FOUND on every endpoint of this resource.

get/v1/subscriptions

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/subscriptions
  • Auth: HTTP bearer

Query parameters

status'trialing' | 'active' | 'incomplete' | 'expired' | 'past_due' | 'canceled' | 'unpaid' | 'paused' | 'processing' | 'succeeded' | 'capturable' | 'failed' | 'pending'
Example:active

Match a single payment status: trialing, active, incomplete, expired, past_due, canceled, unpaid, paused, processing, succeeded, capturable or failed. An unknown value is refused.

plan_idstring uuid nullable

Scope to one plan.

pageinteger

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

per_pageinteger

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

sort_bystring

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

limitinteger

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Response

The page of held subscriptions, newest first.

Example response

{
  "data": [
    {
      "id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
      "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",
      "subscriber_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
      "method_id": "8b0c4a15-e792-4360-95d8-1f47c0b3e926",
      "payment_status": "active",
      "payment_price": "29.00",
      "currency_id": "8f27a0d4-63be-4915-8c07-1a5d9e34b628",
      "ends_at": "2026-06-18T10:05:00Z",
      "created_at": "2026-05-18T10:05:00Z",
      "updated_at": "2026-05-18T10:05:00Z",
      "grants": [
        {
          "id": "7d1c3e9a-2b64-4f0e-9a58-3c6b1d8e2f47",
          "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
          "resource_id": "c9e21f37-8a4b-4d56-b1e0-2f7c9d3a6e15",
          "identity_id": "0c2d8a7e-4b1f-4d3e-9a6b-2f5e8c1d7a90",
          "connector": "telegram",
          "mode": "bearer_link",
          "state": "granted",
          "reference": "https://t.me/+AbCdEfGhIjKlMnOp",
          "granted_at": "2026-09-12T10:05:00Z",
          "created_at": "2026-09-12T10:04:58Z"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.