Subscriptions

List a subscription's grants

curl https://api.subscriby.net/v1/subscriptions/$SUBSCRIPTION_ID/grants \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Every grant the purchase holds, one per resource and dated window, oldest first. Never paginated.

A grant is the access ledger's record that a purchase admits its holder to one resource: one row per resource, and per dated window for a pass. It says which connector gave the access, how (mode), where it stands (state) and, when it failed, why. Read it to know whether a member is actually in the channel rather than inferring it from the payment status.

  • mode is bearer_link (a personal invite link the member comes through), membership (the connector added the member itself), role (a role was assigned) or creator_task (the creator has to do something by hand).
  • state is pending_identity (the member has not linked an account on that connector yet; member.resource_pending was raised, and the grant is issued the moment they connect one), pending (issued, not yet used), held (issued ahead of a pass window and released when it opens), granted, revoked or failed.
  • identity_id is the connector account admitted, the same id the member's identities endpoint returns, or null while none is linked or for a hand-arranged perk.
  • reference is the connector's handle on the grant (the invite link on a connector that grants by link), null before anything was issued. Treat it as a secret: whoever holds a bearer link can use it.
  • A failed grant carries failure_kind (unreachable, not_permitted, target_missing, rate_limited, configuration, transient, other) and failure_detail, the sentence the creator sees in the dashboard.

The ledger is written by the same job that mints invite links, so a purchase's grants appear moments after member.resource_added fires; a revoked link stays as a revoked row rather than disappearing, so history is never lost.

get/v1/subscriptions/{subscription}/grants

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/subscriptions/{subscription}/grants
  • Auth: HTTP bearer

Path parameters

subscriptionstring uuid required

The subscription, resolved by the route binder.

Response

Array of AccessGrantResource

Example response

{
  "data": [
    {
      "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.