List membership seats

Returns the additional customers sharing a membership subscription, with the purchase’s max_seats. The purchasing customer is not listed: they occupy one seat implicitly. Rel: subscriptions:seats.

GET/subscription_purchases/{id}/seats

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idintegerrequired

Subscription purchase ID

Responses

200

Membership seats

_linksHalLinks

total_itemsinteger

Seats in use, not counting the purchasing customer

max_seatsinteger | null

Total seats allowed, including the purchasing customer. Null or 0 means unlimited.

_embeddedobject

Show properties

itemsMembershipSeat[]

Show properties

Array of MembershipSeat

_linksHalLinks

idinteger

subscription_purchase_idinteger

contact_idinteger

contact_emailstring

contact_namestring

created_onstring<date>

403

Token lacks orders.read on the purchase's account

404

Not found, or the purchase is not of a membership plan

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

idpath*Subscription purchase ID

Request

curl -X GET 'https://api.onbolder.com/v2/subscription_purchases/0/seats' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/subscription_purchases/0/seats", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/subscription_purchases/0/seats",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "total_items": 0,
  "max_seats": 0,
  "_embedded": {
    "items": [
      {
        "_links": {
          "property1": {
            "href": "string",
            "templated": true,
            "method": "get",
            "title": "string",
            "type": "string"
          },
          "property2": {
            "href": "string",
            "templated": true,
            "method": "get",
            "title": "string",
            "type": "string"
          }
        },
        "id": 0,
        "subscription_purchase_id": 0,
        "contact_id": 0,
        "contact_email": "string",
        "contact_name": "string",
        "created_on": "2019-08-24"
      }
    ]
  }
}