v7

latestOpenAPI 3.1.02026-08-051856761.1 MB

customer-seats

public

Revoke Seat

Scopes: customer_seats:write

delete/v1/customer-seats/{seat_id}

seat_idstring uuid4 required

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

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