Skip to content
Get started

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

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