Retrieve a subscription

GET

/subscriptions/{subscription_id}

Authorizations

bearerToken|siteContext

bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)

+

siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)

or

siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters

Path Parameters

subscription_id*

Subscription identifier

Typestring

Required

Responses

subscription returned

Content-Type

application/json

{

"id": "string",

"state": "string",

"amount": 0,

"subscription_interval": 0,

"subscription_interval_unit": "string",

"subscription_times": 0,

"last_paid_at": "string",

"valid_until": "string",

"cancel_reason": "string",

"customer_id": "string",

"created_at": "string",

"updated_at": "string"

}

GET

/subscriptions/{subscription_id}

Playground

Authorization

bearerToken

siteContext

Variables

Key

Value

subscription_id*

Samples