v6

OpenAPI 3.1.02026-07-311856741.1 MB

customer_portal

seats

public

Assign Seat

post/v1/customer-portal/seats

Request body

subscription_idstring uuid nullable

Subscription ID. Required if neither order_id nor checkout_id is provided.

order_idstring uuid nullable

Order ID for one-time purchases. Required if subscription_id is not provided.

emailstring email nullable

Email of the customer to assign the seat to

external_customer_idstring nullable

External customer ID for the seat assignment

customer_idstring uuid nullable

Customer ID for the seat assignment

external_member_idstring nullable

External member ID for the seat assignment. Can be used alone (lookup existing member) or with email (create/validate member).

member_idstring uuid nullable

Member ID for the seat assignment.

metadataobject nullable

Additional metadata for the seat (max 10 keys, 1KB total)

immediate_claimboolean

If true, the seat will be immediately claimed without sending an invitation email. API-only feature.

checkout_idstring uuid nullable

Checkout ID. Resolves to the subscription or order produced by the checkout.

Response

Successful Response

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid required

The seat ID

subscription_idstring uuid nullable required

The subscription ID (for recurring seats)

order_idstring uuid nullable required

The order ID (for one-time purchase seats)

status'pending' | 'claimed' | 'revoked' required

customer_idstring uuid nullable required

The customer ID. When member_model_enabled is true, this is the billing customer (purchaser). When false, this is the seat member customer.

member_idstring uuid nullable required

The member ID of the seat occupant

emailstring nullable required

Email of the seat member (set when member_model_enabled is true)

customer_emailstring nullable required

The assigned customer email

invitation_token_expires_atstring date-time nullable required

When the invitation token expires

claimed_atstring date-time nullable required

When the seat was claimed

revoked_atstring date-time nullable required

When the seat was revoked

seat_metadataobject nullable required

Additional metadata for the seat

Example response

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