CustomerOrderProduct
July 20, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | str | :heavy_check_mark: | The ID of the object. |
created_at | date | :heavy_check_mark: | Creation timestamp of the object. |
modified_at | date | :heavy_check_mark: | Last modification timestamp of the object. |
trial_interval | Nullable[models.TrialInterval] | :heavy_check_mark: | The interval unit for the trial period. |
trial_interval_count | Nullable[int] | :heavy_check_mark: | The number of interval units for the trial period. |
name | str | :heavy_check_mark: | The name of the product. |
description | Nullable[str] | :heavy_check_mark: | The description of the product. |
visibility | models.ProductVisibility | :heavy_check_mark: | N/A |
recurring_interval | Nullable[models.RecurringInterval] | :heavy_check_mark: | The recurring interval of the product. If None, the product is a one-time purchase. |
recurring_interval_count | Nullable[int] | :heavy_check_mark: | Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products. |
meter_interval | Nullable[models.RecurringInterval] | :heavy_check_mark: | The meter cycle of the product, independent of the billing interval. If None, metered concerns follow the billing interval. |
meter_interval_count | Nullable[int] | :heavy_check_mark: | Number of meter interval units. None when no meter cycle is set. |
is_recurring | bool | :heavy_check_mark: | Whether the product is a subscription. |
is_archived | bool | :heavy_check_mark: | Whether the product is archived and no longer available. |
organization_id | str | :heavy_check_mark: | The ID of the organization owning the product. |
prices | List[models.CustomerOrderProductPrices] | :heavy_check_mark: | List of prices for this product. |
benefits | List[models.BenefitPublic] | :heavy_check_mark: | List of benefits granted by the product. |
medias | List[models.ProductMediaFileRead] | :heavy_check_mark: | List of medias associated to the product. |
organization | models.CustomerOrganization | :heavy_check_mark: | N/A |