Change Product
Intent
Applies the supplied changes to the product.
When to call it
Call this when the product already exists and its stored values need to change.
Access boundary
Authorize the request with a token that carries products:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the product.
Body
Schema used to update a product.
Metadata map for information your integration needs to retain.
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.
Unit used to measure the trial period.
day, week, month, year Length of the trial measured in the selected interval.
1 <= x <= 1000Customer-facing name assigned to the product.
3 - 64Customer-facing description attached to the product.
Recurring Interval: 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..
day, week, month, year Count 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. Once set, it can't be changed.**.
1 <= x <= 999Indicates 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.
Controls where customers can discover the product.
draft, private, public Collection of available prices for this product. If you want to keep existing prices, include them in the list as an ExistingProductPrice object.
A price that already exists for this product.
Useful when updating a product if you want to keep an existing price.
- ExistingProductPrice
- ProductPriceFixedCreate
- ProductPriceCustomCreate
- ProductPriceSeatBasedCreate
- ProductPriceMeteredUnitCreate
Collection of file IDs. Each one must be on the same organization as the product, of type product_media and correctly uploaded.
Collection of custom fields to attach.
Response
Response: Product updated.
Object representing product.
The stable identifier for this record.
The time Ruba created this record.
The time this record last changed.
Unit used to measure the trial period.
day, week, month, year Length of the trial measured in the selected interval.
Customer-facing name assigned to the product.
Customer-facing description attached to the product.
Controls where customers can discover the product.
draft, private, public Recurring Interval: Recurring interval of the product. If None, the product is a one-time purchase.
day, week, month, year Count 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.
Indicates whether the product is a subscription.
Indicates whether the product is archived and no longer available.
Unique identifier for the organization owning the product.
Collection of prices for this product.
A recurring price for a product, i.e. a subscription.
Deprecated: The recurring interval should be set on the product itself.
- LegacyRecurringProductPriceFixed
- LegacyRecurringProductPriceCustom
- ProductPriceFixed
- ProductPriceCustom
- ProductPriceSeatBased
- ProductPriceMeteredUnit
Collection of benefits granted by the product.
A benefit of type custom.
Use it to grant any kind of benefit that doesn't fit in the other types.
- BenefitCustom
- BenefitDiscord
- BenefitGitHubRepository
- BenefitDownloadables
- BenefitLicenseKeys
- BenefitMeterCredit
- BenefitFeatureFlag
Collection of medias associated to the product.
Collection of custom fields attached to the product.