customer_portal
seats
public

List Seats

Scopes: customer_portal:read customer_portal:write

get/v1/customer-portal/seats

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customer-portal/seats
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

subscription_idstring uuid4 nullable

Subscription ID

order_idstring uuid4 nullable

Order ID

Response

Successful Response

available_seatsinteger required

Number of available seats

total_seatsinteger required

Total number of seats for the subscription

Example response

{
  "seats": [
    {
      "member": {
        "email": "member@example.com",
        "name": "Jane Doe",
        "external_id": "usr_1337"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 11 revisions of this API.