Get Subscription | Neobits API Documentation

getGet Subscription

Retrieves one of your tenant's subscriptions, with its plan. Your client's subscription_id (see Get Client) is the subscription Fuse serves it under. Your token must carry subscription:read, which the owner and admin roles grant.

curl --request GET \
  --url https://your-tenant.core.server.test.neobits.ai/v1/subscriptions/0197a1b2-0000-7000-8000-000000000001 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Request

Headers

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

Params (path)

subscription_id•string<uuid>
The subscription ID
Required

Response

Headers

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

Body

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