Product data for a checkout link.
| Field | Type | Required | Description |
|---|---|---|---|
metadata |
Dict[str, models.MetadataOutputType] | ✔️ | N/A |
id |
str | ✔️ | The ID of the object. |
created_at |
date | ✔️ | Creation timestamp of the object. |
modified_at |
date | ✔️ | Last modification timestamp of the object. |
trial_interval |
Nullable[models.TrialInterval] | ✔️ | The interval unit for the trial period. |
trial_interval_count |
Nullable[int] | ✔️ | The number of interval units for the trial period. |
name |
str | ✔️ | The name of the product. |
description |
Nullable[str] | ✔️ | The description of the product. |
visibility |
models.ProductVisibility | ✔️ | N/A |
recurring_interval |
Nullable[models.SubscriptionRecurringInterval] | ✔️ | The recurring interval of the product. If None, the product is a one-time purchase. |
recurring_interval_count |
Nullable[int] | ✔️ | 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. |
is_recurring |
bool | ✔️ | Whether the product is a subscription. |
is_archived |
bool | ✔️ | Whether the product is archived and no longer available. |
organization_id |
str | ✔️ | The ID of the organization owning the product. |
prices |
List[models.CheckoutLinkProductPrices] | ✔️ | List of prices for this product. |
benefits |
List[models.BenefitPublic] | ✔️ | List of benefits granted by the product. |
medias |
List[models.ProductMediaFileRead] | ✔️ | List of medias associated to the product. |