Update Product
Update a product.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The product ID.
Body
Schema to update a product.
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 boolean
You can store up to 50 key-value pairs.
The name of the product.
3The description of the product.
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.
month, year 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.
List of available prices for this product. If you want to keep existing prices, include them in the list as an ExistingProductPrice object.
List of file IDs. Each one must be on the same organization as the product, of type product_media and correctly uploaded.
List of custom fields to attach.
Response
A product.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the product.
The name of the product.
The description of the product.
The recurring interval of the product. If None, the product is a one-time purchase.
month, year Whether the product is a subscription.
Whether the product is archived and no longer available.
The ID of the organization owning the product.
List of prices for this product.
List of benefits granted by the product.
List of medias associated to the product.
List of custom fields attached to the product.
Was this page helpful?