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


with Polar() as polar:

    res = polar.customer_seats.claim_seat(request={
        "invitation_token": "<value>",
    })

    # Handle response
    print(res)
{
  "seat": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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": {}
  },
  "customer_session_token": "<string>"
}

Body

application/json
invitation_token
string
required

Invitation token to claim the seat

Response

Successful Response

Response after successfully claiming a seat.

seat
object
required

The claimed seat

customer_session_token
string
required

Session token for immediate customer portal access