Add a membership seat

Gives a customer a seat. The customer must belong to the same shop and to the same company as the purchasing customer, can hold only one seat per purchase, and the purchase must not have reached max_seats (the purchasing customer counts as one). By default the call is made on behalf of the seller (initiated_by: admin) and notification emails are sent to the added customer and to the buyer. With initiated_by: buyer (the buyer managing their own seats) no emails are sent, and the plan must allow self-service seat management. Sends subscription.seat_added. Rel: subscriptions:create_seat.

POST/subscription_purchases/{id}/seats

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idintegerrequired

Subscription purchase ID

Request body

requiredapplication/json

contact_idintegerrequired

Customer to give the seat to

initiated_bystring

default: "admin"

Allowed:adminbuyer

Responses

201

Seat created

_linksHalLinks

idinteger

subscription_purchase_idinteger

contact_idinteger

contact_emailstring

contact_namestring

created_onstring<date>

403

Token lacks orders.write on the purchase's account

404

Purchase or customer not found, or the purchase is not of a membership plan

422

contact_id missing, seat limit reached, customer already has a seat, customer is not in the buyer's company, or self-service is not enabled for the plan (with initiated_by buyer)

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

Bodyapplication/json

contact_idinteger*Customer to give the seat toinitiated_bystring

Request

curl -X POST 'https://api.onbolder.com/v2/subscription_purchases/0/seats' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "contact_id": 4521
}'

const response = await fetch("https://api.onbolder.com/v2/subscription_purchases/0/seats", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"contact_id\": 4521\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/subscription_purchases/0/seats",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"contact_id\": 4521\n}",
)

Response

{
  "_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"
}