Skip to main content
GET
Retrieve subscriptions

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

subscriptions.readonly

Read subscriptions

subscriptions

Read and write subscriptions

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

createDate[gte]
string

Filter subscriptions created on or after this date (ISO 8601). Use with createDate[lte] for a range.

createDate[lte]
string

Filter subscriptions created on or before this date (ISO 8601). Use with createDate[gte] for a range.

customerRef
string<uuid>

UUID of the customer whose subscriptions to list.

limit
integer

Maximum number of subscriptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose subscriptions to list. Omit locationRef and customerRef to list subscriptions across every location of the network, grouped by location.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

order
string

Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions and needs locationRef. Defaults to createDate:desc.

planRef
string<uuid>

UUID of the plan to filter subscriptions by. Applies to a location's or the network's subscriptions.

status
string

Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended, 'requested' asked for by a person and not approved by an administrator yet, 'declined' a request an administrator declined or nobody answered in time, 'withdrawn' a request the person took back. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled, requested, declined, withdrawn.

Response

OK

subscriptions
object[]
required

List of subscriptions.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.