Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 12.3 KB

productupdate.md

File metadata and controls

17 lines (13 loc) · 12.3 KB

ProductUpdate

Schema to update a product.

Fields

Field Type Required Description
Metadata map[string]components.ProductUpdateMetadata Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters.
The value must be either:

* A string with a maximum length of 500 characters
* An integer
* A floating-point number
* A boolean

You can store up to 50 key-value pairs.
Name *string N/A
Description *string The description of the product.
RecurringInterval *components.SubscriptionRecurringInterval The recurring interval of the product. If None, the product is a one-time purchase. Can only be set on legacy recurring products. Once set, it can't be changed.
IsArchived *bool Whether the product is archived. If true, the product won't be available for purchase anymore. Existing customers will still have access to their benefits, and subscriptions will continue normally.
Prices []components.ProductUpdatePrices List of available prices for this product. If you want to keep existing prices, include them in the list as an ExistingProductPrice object.
Medias []string List of file IDs. Each one must be on the same organization as the product, of type product_media and correctly uploaded.
AttachedCustomFields []components.AttachedCustomFieldCreate N/A