API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Express

Create a new customer

client.express.create(ExpressCreateParams { expressCustomerName, metadata } body, RequestOptionsoptions?): ExpressCreateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

POST/v1/express

List customers with pagination

client.express.list(ExpressListParams { cursor, limit } query?, RequestOptionsoptions?): CursorExpressCustomers<ExpressListResponse { createdAt, expressCustomerId, expressCustomerName, 6 more } >

GET/v1/express

Retrieve a customer by ID

client.express.retrieve(stringexpressCustomerID, RequestOptionsoptions?): ExpressRetrieveResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

GET/v1/express/{expressCustomerId}

Update a customer

client.express.update(stringexpressCustomerID, ExpressUpdateParams { expressCustomerName, metadata } body?, RequestOptionsoptions?): ExpressUpdateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

PATCH/v1/express/{expressCustomerId}

Deactivate a customer

client.express.deactivate(stringexpressCustomerID, RequestOptionsoptions?): ExpressDeactivateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

POST/v1/express/{expressCustomerId}/deactivate

Reactivate a customer

client.express.reactivate(stringexpressCustomerID, RequestOptionsoptions?): ExpressReactivateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

POST/v1/express/{expressCustomerId}/reactivate

ModelsExpand Collapse

ExpressCreateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

createdAt: string | null

Timestamp when the Express customer was created

formatdate-time

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

isActive: boolean

Whether the Express customer is currently active

updatedAt: string | null

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId?: string

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

formatuuid

createdByUserId?: string

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

metadata?: Record<string, string>

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

ExpressListResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

createdAt: string | null

Timestamp when the Express customer was created

formatdate-time

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

isActive: boolean

Whether the Express customer is currently active

updatedAt: string | null

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId?: string

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

formatuuid

createdByUserId?: string

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

metadata?: Record<string, string>

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

ExpressRetrieveResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

createdAt: string | null

Timestamp when the Express customer was created

formatdate-time

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

isActive: boolean

Whether the Express customer is currently active

updatedAt: string | null

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId?: string

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

formatuuid

createdByUserId?: string

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

metadata?: Record<string, string>

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

ExpressUpdateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

createdAt: string | null

Timestamp when the Express customer was created

formatdate-time

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

isActive: boolean

Whether the Express customer is currently active

updatedAt: string | null

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId?: string

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

formatuuid

createdByUserId?: string

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

metadata?: Record<string, string>

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

ExpressDeactivateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

createdAt: string | null

Timestamp when the Express customer was created

formatdate-time

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

isActive: boolean

Whether the Express customer is currently active

updatedAt: string | null

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId?: string

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

formatuuid

createdByUserId?: string

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

metadata?: Record<string, string>

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

ExpressReactivateResponse { createdAt, expressCustomerId, expressCustomerName, 6 more }

An Express customer entity that groups users and studies

createdAt: string | null

Timestamp when the Express customer was created

formatdate-time

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

isActive: boolean

Whether the Express customer is currently active

updatedAt: string | null

Timestamp when the Express customer was last updated

formatdate-time

userCount: number

Number of users currently in this Express customer

minimum0

createdByApiKeyId?: string

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

formatuuid

createdByUserId?: string

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

metadata?: Record<string, string>

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

client.express.users.add(stringexpressCustomerID, UserAddParams { userId } body, RequestOptionsoptions?): UserAddResponse { success, message }

POST/v1/express/{expressCustomerId}/users

Remove a user from a customer

client.express.users.remove(stringexpressCustomerID, UserRemoveParams { userId } body, RequestOptionsoptions?): UserRemoveResponse { success, message }

DELETE/v1/express/{expressCustomerId}/users

ModelsExpand Collapse

UserAddResponse { success, message }

Standard success response with optional message

success: boolean

message?: string

UserRemoveResponse { success, message }

Standard success response with optional message

success: boolean

message?: string