GET/api/v4/subscriptions

List active subscriptions

Returns the active billing subscriptions (plans and tenures) on the account.

Requires an API key. See Authentication for header format and key rotation.

Parameters

Query

NameTypeRequiredDescriptionDefault
accountIdstringoptionalRestrict the result to a specific account. Defaults to the account that owns the API key.

Responses

200The account's active subscriptions.
{
  "data": {
    "activeSubscriptions": [
      {
        "name": "Launch",
        "paymentSubscriptionId": "61ab21be-11b8-4828-b292-75dc008aba97",
        "planId": "price_0TeANIppwoE3L8zjHjemFTNj",
        "tenure": "NA"
      }
    ]
  }
}
401Unauthenticated — missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Returns every active subscription on the account. Each entry describes one plan the account is billed on:

  • name — the plan's display name (for example Launch).
  • planId — the billing plan identifier.
  • paymentSubscriptionId — the underlying payment-provider subscription id.
  • tenure — the billing cadence (Monthly, Yearly, or NA when the plan has no fixed term).

Picking the right tenure before creating a location

On accounts that carry more than one subscription tier, createLocation needs to know which subscription the new location should consume a seat from. That is selected by passing the subscription's tenure in the create request's input.tenure field. Call this endpoint first, choose the subscription you want to bill against, and forward its tenure:

const res = await fetch('https://listingsapi.com/api/v4/subscriptions', {
  headers: { Authorization: 'API ' + process.env.LISTINGSAPI_KEY },
});
const { data } = await res.json();
const tenure = data.activeSubscriptions[0].tenure; // "NA" on a single-plan account

Accounts with a single plan (like this one) return one entry whose tenure may be NA; pass that value through unchanged. See Create a location for the full create payload.

The response is a single unpaginated array and counts against your account rate limit — a 429 response carries a Retry-After header telling you when to retry.

curl -X GET 'https://listingsapi.com/api/v4/subscriptions' \
  -H "Authorization: API $LISTINGSAPI_KEY"