List Subscriptions | Neobits API Documentation

getList Subscriptions

Lists your tenant's subscriptions, with their plans, in ascending ID order, whether or not they have started or ended. Use page.after from a response as after to get the next page. Your token must carry subscriptions:read, which the owner and admin roles grant. List your tenant's products with List Products.

curl --request GET \
  --url 'https://your-tenant.core.server.test.neobits.ai/v1/subscriptions?size=50&after=SOME_STRING_VALUE&before=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Request

Headers

Authorization•string
Bearer token authentication using OAuth 2.0 client credentials flow.
Required

Params (query)

size•integer
Maximum subscriptions to return (1–5,000). Defaults to 50.
after•string<uuid>
Exclusive subscription ID cursor. Returns subscriptions after it; use `page.after` from a previous response.
before•string<uuid>
Exclusive subscription ID cursor. Returns subscriptions before it; use `page.before` from a previous response.

Response

Headers

Content-Type•string
The content type of the response.

Body

data•array<object>
Required
id•string<uuid>
Subscription ID. Set it as a client's `subscription_id` to let Fuse serve the client.
Required
description•string
What the subscription is for
Required
starts_at•string<date-time>
When the subscription starts
Required
ends_at•string<date-time>
When the subscription ends. Null when it has no end.
RequiredNullable
plan•object
Required
id•string<uuid>
Plan ID
Required
name•string
The plan's name
Required
description•string
What the plan includes. Present only when the plan has a description.
billing•object
Required
frequency•string
How often the plan is invoiced
Required
terms•string
Days to pay an invoice
Required
created_at•string<date-time>
When the plan was created
Required
updated_at•string<date-time>
When the plan was last changed
Required
created_at•string<date-time>
When the subscription was created
Required
updated_at•string<date-time>
When the subscription was last changed
Required
page•object
Required
size•integer
Number of items returned in this page
Required
total•integer
Total number of items, independent of the cursor
Required
before•string<uuid>
First returned ID. Use as `before` to request the preceding page. Null for an empty page.
RequiredNullable
after•string<uuid>
Last returned ID. Use as `after` to request the following page. Null for an empty page.
RequiredNullable