Skip to main content
GET
/
v1
/
customer-portal
/
seats
Python (SDK)
import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.seats.list_seats(security=polar_sdk.CustomerPortalSeatsListSeatsSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ))

    # Handle response
    print(res)
{
  "seats": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "customer_email": "<string>",
      "invitation_token_expires_at": "2023-11-07T05:31:56Z",
      "claimed_at": "2023-11-07T05:31:56Z",
      "revoked_at": "2023-11-07T05:31:56Z",
      "seat_metadata": {}
    }
  ],
  "available_seats": 123,
  "total_seats": 123
}

Authorizations

​
Authorization
string
header
required

Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.

Query Parameters

​
subscription_id
string<uuid4> | null

Subscription ID

​
order_id
string<uuid4> | null

Order ID

Response

Successful Response

​
seats
CustomerSeat · object[]
required

List of seats

​
available_seats
integer
required

Number of available seats

​
total_seats
integer
required

Total number of seats for the subscription