Read Product
Intent
Reads the product without changing it.
When to call it
Call this after your application has received or stored the identifier for the product.
Access boundary
Authorize the request with a token that carries products:read or 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.
Response
Request completed successfully
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.