API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Express

Create a new customer

express.create(ExpressCreateParams**kwargs) -> ExpressCreateResponse

POST/v1/express

List customers with pagination

express.list(ExpressListParams**kwargs) -> SyncCursorExpressCustomers[ExpressListResponse]

GET/v1/express

Retrieve a customer by ID

express.retrieve(strexpress_customer_id) -> ExpressRetrieveResponse

GET/v1/express/{expressCustomerId}

Update a customer

express.update(strexpress_customer_id, ExpressUpdateParams**kwargs) -> ExpressUpdateResponse

PATCH/v1/express/{expressCustomerId}

Deactivate a customer

express.deactivate(strexpress_customer_id) -> ExpressDeactivateResponse

POST/v1/express/{expressCustomerId}/deactivate

Reactivate a customer

express.reactivate(strexpress_customer_id) -> ExpressReactivateResponse

POST/v1/express/{expressCustomerId}/reactivate

ModelsExpand Collapse

class ExpressCreateResponse: …

An Express customer entity that groups users and studies

created_at: Optional[datetime]

Timestamp when the Express customer was created

formatdate-time

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1

is_active: bool

Whether the Express customer is currently active

updated_at: Optional[datetime]

Timestamp when the Express customer was last updated

formatdate-time

user_count: int

Number of users currently in this Express customer

minimum0

created_by_api_key_id: Optional[str]

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

created_by_user_id: Optional[str]

User ID who created this Express customer via dashboard, null if created via API key

metadata: Optional[Dict[str, str]]

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

class ExpressListResponse: …

An Express customer entity that groups users and studies

created_at: Optional[datetime]

Timestamp when the Express customer was created

formatdate-time

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1

is_active: bool

Whether the Express customer is currently active

updated_at: Optional[datetime]

Timestamp when the Express customer was last updated

formatdate-time

user_count: int

Number of users currently in this Express customer

minimum0

created_by_api_key_id: Optional[str]

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

created_by_user_id: Optional[str]

User ID who created this Express customer via dashboard, null if created via API key

metadata: Optional[Dict[str, str]]

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

class ExpressRetrieveResponse: …

An Express customer entity that groups users and studies

created_at: Optional[datetime]

Timestamp when the Express customer was created

formatdate-time

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1

is_active: bool

Whether the Express customer is currently active

updated_at: Optional[datetime]

Timestamp when the Express customer was last updated

formatdate-time

user_count: int

Number of users currently in this Express customer

minimum0

created_by_api_key_id: Optional[str]

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

created_by_user_id: Optional[str]

User ID who created this Express customer via dashboard, null if created via API key

metadata: Optional[Dict[str, str]]

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

class ExpressUpdateResponse: …

An Express customer entity that groups users and studies

created_at: Optional[datetime]

Timestamp when the Express customer was created

formatdate-time

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1

is_active: bool

Whether the Express customer is currently active

updated_at: Optional[datetime]

Timestamp when the Express customer was last updated

formatdate-time

user_count: int

Number of users currently in this Express customer

minimum0

created_by_api_key_id: Optional[str]

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

created_by_user_id: Optional[str]

User ID who created this Express customer via dashboard, null if created via API key

metadata: Optional[Dict[str, str]]

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

class ExpressDeactivateResponse: …

An Express customer entity that groups users and studies

created_at: Optional[datetime]

Timestamp when the Express customer was created

formatdate-time

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1

is_active: bool

Whether the Express customer is currently active

updated_at: Optional[datetime]

Timestamp when the Express customer was last updated

formatdate-time

user_count: int

Number of users currently in this Express customer

minimum0

created_by_api_key_id: Optional[str]

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

created_by_user_id: Optional[str]

User ID who created this Express customer via dashboard, null if created via API key

metadata: Optional[Dict[str, str]]

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

class ExpressReactivateResponse: …

An Express customer entity that groups users and studies

created_at: Optional[datetime]

Timestamp when the Express customer was created

formatdate-time

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1

is_active: bool

Whether the Express customer is currently active

updated_at: Optional[datetime]

Timestamp when the Express customer was last updated

formatdate-time

user_count: int

Number of users currently in this Express customer

minimum0

created_by_api_key_id: Optional[str]

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

created_by_user_id: Optional[str]

User ID who created this Express customer via dashboard, null if created via API key

metadata: Optional[Dict[str, str]]

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

ExpressUsers

Add a user to a customer

express.users.add(strexpress_customer_id, UserAddParams**kwargs) -> UserAddResponse

POST/v1/express/{expressCustomerId}/users

Remove a user from a customer

express.users.remove(strexpress_customer_id, UserRemoveParams**kwargs) -> UserRemoveResponse

DELETE/v1/express/{expressCustomerId}/users

ModelsExpand Collapse

class UserAddResponse: …

Standard success response with optional message

success: bool

message: Optional[str]

class UserRemoveResponse: …

Standard success response with optional message

success: bool

message: Optional[str]