class

Polar::Api::CustomerPortal::Seats

Inherits Reference < Object

API client for seats operations in customer_portal context

Constants

Log = ::Log.for(self)

Constructors

new(client : Client)

Creates a new Seats instance

@param client [Client] The Polar API client instance

Source

Instance methods

assign_seat(body : Polar::Models::SeatAssign) : Polar::Models::CustomerSeat

Assign Seat

Scopes: customer_portal:write

Endpoint: POST /v1/customer-portal/seats

Parameters:

  • body (required): Request body as Polar::Models::SeatAssign

Returns: Polar::Models::CustomerSeat

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
list_claimed_subscriptions

List Claimed Subscriptions

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

Scopes: customer_portal:read customer_portal:write

Endpoint: GET /v1/customer-portal/seats/subscriptions

Returns: JSON response string

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
list_seats(subscription_id : String | Nil = nil, order_id : String | Nil = nil) : Polar::Models::SeatsList

List Seats

Scopes: customer_portal:read customer_portal:write

Endpoint: GET /v1/customer-portal/seats

Parameters:

  • subscription_id (optional): Subscription ID
  • order_id (optional): Order ID

Returns: Polar::Models::SeatsList

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
resend_invitation(seat_id : String) : Polar::Models::CustomerSeat

Resend Invitation

Scopes: customer_portal:write

Endpoint: POST /v1/customer-portal/seats/{seat_id}/resend

Parameters:

  • seat_id (required): Path parameter

Returns: Polar::Models::CustomerSeat

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source
revoke_seat(seat_id : String) : Polar::Models::CustomerSeat

Revoke Seat

Scopes: customer_portal:write

Endpoint: DELETE /v1/customer-portal/seats/{seat_id}

Parameters:

  • seat_id (required): Path parameter

Returns: Polar::Models::CustomerSeat

Raises:

  • ResourceNotFoundError on 404
  • NotPermittedError on 403
  • HTTPValidationError on 422
  • PolarError on other errors
Source