Create

products.create() -> ProductCreateResponse

POST/products

Creates a new product

ParametersExpand Collapse

code: str

Product code (unique identifier)

description: str

Description of the product

paid_by_roles: Optional[Iterable[PaidByRole]]

Roles that can pay for this product. Reference roles by id or name. At least one of paid_by_roles or paid_to_roles must be provided.

Accepts one of the following:

class PaidByRoleRoleMatchByID: …

id: str

The unique ID of the role

class PaidByRoleRoleMatchByName: …

The name of the role

paid_to_roles: Optional[Iterable[PaidToRole]]

Roles that receive payment for this product. Reference roles by id or name. At least one of paid_by_roles or paid_to_roles must be provided.

Accepts one of the following:

class PaidToRoleRoleMatchByID: …

id: str

The unique ID of the role

class PaidToRoleRoleMatchByName: …

The name of the role

ReturnsExpand Collapse

class ProductCreateResponse: …

data: Data

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

description: str

Description of the product

paid_by_roles: List[DataPaidByRole]

User roles that can pay for this product

id: str

The unique ID of the role

The name of the role

paid_to_roles: List[DataPaidToRole]

User roles that receive payment for this product

id: str

The unique ID of the role

The name of the role

update_version: float

Version number for optimistic locking

workspace_id: str

Workspace ID this product belongs to

Create

from fragment import Fragment

client = Fragment()
product = client.products.create(
    code="PROD_001",
    description="Premium subscription service",
)
print(product.data)

{
  "data": {
    "id": "product_1234567890",
    "code": "PROD_001",
    "created": "2024-01-13T00:00:00Z",
    "description": "Premium subscription service",
    "paid_by_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "paid_to_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "updateVersion": 1,
    "workspaceId": "ws_1234567890"
  }
}

Returns Examples

{
  "data": {
    "id": "product_1234567890",
    "code": "PROD_001",
    "created": "2024-01-13T00:00:00Z",
    "description": "Premium subscription service",
    "paid_by_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "paid_to_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "updateVersion": 1,
    "workspaceId": "ws_1234567890"
  }
}