CustomerSeatAssign
May 19, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | OptionalNullable[str] | :heavy_minus_sign: | Subscription ID. Required if neither order_id nor checkout_id is provided. |
order_id | OptionalNullable[str] | :heavy_minus_sign: | Order ID for one-time purchases. Required if subscription_id is not provided. |
email | OptionalNullable[str] | :heavy_minus_sign: | Email of the customer to assign the seat to |
external_customer_id | OptionalNullable[str] | :heavy_minus_sign: | External customer ID for the seat assignment |
customer_id | OptionalNullable[str] | :heavy_minus_sign: | Customer ID for the seat assignment |
external_member_id | OptionalNullable[str] | :heavy_minus_sign: | External member ID for the seat assignment. Can be used alone (lookup existing member) or with email (create/validate member). |
member_id | OptionalNullable[str] | :heavy_minus_sign: | Member ID for the seat assignment. |
metadata | Dict[str, Any] | :heavy_minus_sign: | Additional metadata for the seat (max 10 keys, 1KB total) |
immediate_claim | Optional[bool] | :heavy_minus_sign: | If true, the seat will be immediately claimed without sending an invitation email. API-only feature. |
checkout_id | OptionalNullable[str] | :heavy_minus_sign: | Checkout ID. Resolves to the subscription or order produced by the checkout. |