Seats

(customer_portal.seats)

Overview

Available Operations

• list_seats - List Seats
• assign_seat - Assign Seat
• revoke_seat - Revoke Seat
• resend_invitation - Resend Invitation
• list_claimed_subscriptions - List Claimed Subscriptions

list_seats

Scopes: customer_portal:read customer_portal:write

Example Usage

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>",
    ), subscription_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
security	models.CustomerPortalSeatsListSeatsSecurity	:heavy_check_mark:	N/A
subscription_id	OptionalNullable[str]	:heavy_minus_sign:	Subscription ID
order_id	OptionalNullable[str]	:heavy_minus_sign:	Order ID
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.SeatsList

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

assign_seat

Assign Seat

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.seats.assign_seat(security=polar_sdk.CustomerPortalSeatsAssignSeatSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), request={})

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	models.CustomerSeatAssign	:heavy_check_mark:	The request object to use for the request.
security	models.CustomerPortalSeatsAssignSeatSecurity	:heavy_check_mark:	The security requirements to use for the request.
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerSeat

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

revoke_seat

Revoke Seat

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.seats.revoke_seat(security=polar_sdk.CustomerPortalSeatsRevokeSeatSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), seat_id="4b3d74b3-01ff-4aac-bd03-320535cd5ce4")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
security	models.CustomerPortalSeatsRevokeSeatSecurity	:heavy_check_mark:	N/A
seat_id	str	:heavy_check_mark:	N/A
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerSeat

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

resend_invitation

Resend Invitation

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.seats.resend_invitation(security=polar_sdk.CustomerPortalSeatsResendInvitationSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), seat_id="e3817437-8d53-4578-88d2-1dc256825965")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
security	models.CustomerPortalSeatsResendInvitationSecurity	:heavy_check_mark:	N/A
seat_id	str	:heavy_check_mark:	N/A
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerSeat

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

list_claimed_subscriptions

List all subscriptions where the authenticated customer has claimed a seat.

Scopes: customer_portal:read customer_portal:write

Example Usage

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.seats.list_claimed_subscriptions(security=polar_sdk.CustomerPortalSeatsListClaimedSubscriptionsSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
security	models.CustomerPortalSeatsListClaimedSubscriptionsSecurity	:heavy_check_mark:	N/A
page	Optional[int]	:heavy_minus_sign:	Page number, defaults to 1.
limit	Optional[int]	:heavy_minus_sign:	Size of a page, defaults to 10. Maximum is 100.
retries	Optional[utils.RetryConfig]	:heavy_minus_sign:	Configuration to override the default retry behavior of the client.

Response

models.CustomerPortalSeatsListClaimedSubscriptionsResponse

Errors

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*