Skip to content

List subscriptions

GET
/subscriptions

Returns all subscriptions on the site.

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)

Responses

subscriptions listed

application/json
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"
}
]

Playground

Authorization

Samples

Part of Nimbu, built by Zenjoy.