API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Products

Create

products.create(ProductCreateParams**kwargs) -> ProductCreateResponse

POST/products

List

products.list() -> ProductListResponse

GET/products

Retrieve

products.retrieve(strcode) -> ProductRetrieveResponse

GET/products/{code}

ModelsExpand Collapse

class Product: …

Product object

id: str

Unique identifier for the product

code: str

User-defined product identifier.

created: datetime

ISO 8601 timestamp when the product was created

formatdate-time

paid_by_roles: List[PaidByRole]

User roles that can pay for this product

id: str

The unique ID of the role

name: str

The name of the role

paid_to_roles: List[PaidToRole]

User roles that receive payment for this product

id: str

The unique ID of the role

name: str

The name of the role

update_version: float

Version number for optimistic locking

workspace_id: str

Workspace ID this product belongs to

description: Optional[str]

Description of the product