Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 16.1 KB

Product.md

File metadata and controls

22 lines (18 loc) · 16.1 KB

Product

A product.

Fields

Field Type Required Description
createdAt \DateTime ✔️ Creation timestamp of the object.
id string ✔️ The ID of the product.
name string ✔️ The name of the product.
isRecurring bool ✔️ Whether the product is a subscription tier.
isArchived bool ✔️ Whether the product is archived and no longer available.
organizationId string ✔️ The ID of the organization owning the product.
metadata array<string, string|int|bool> ✔️ N/A
prices array<Components\ProductPriceRecurringFixed|Components\ProductPriceRecurringCustom|Components\ProductPriceRecurringFree|Components\ProductPriceOneTimeFixed|Components\ProductPriceOneTimeCustom|Components\ProductPriceOneTimeFree> ✔️ List of prices for this product.
benefits array<Components\BenefitAds|Components\BenefitCustom|Components\BenefitDiscord|Components\BenefitGitHubRepository|Components\BenefitDownloadables|Components\BenefitLicenseKeys> ✔️ List of benefits granted by the product.
medias array<Components\ProductMediaFileRead> ✔️ List of medias associated to the product.
attachedCustomFields array<Components\AttachedCustomField> ✔️ List of custom fields attached to the product.
modifiedAt \DateTime ✔️ Last modification timestamp of the object.
description string ✔️ The description of the product.