Overview
A Product Price object describes a price associated with a specific product.
A product can have more than one price associated with it. That is because Inspire offers several pricing models venders can leverage.
To review pricing models, read About pricing models.
Product Price object properties
A Product Price object returned by the endpoints in this section can have the following properties:
| Name | Type | Description |
|---|---|---|
id | String | Product price ID |
name | String | Product price name |
productsId | String | Product ID |
products | Object | Object describing the product this price is associated with |
unitPrice | Number | Unit price |
installments | Number | The number of installments |
packageUnits | Number | Number of units in a package. Used in the Package Pricing model. |
internalDescription | String | Internal product description |
recurringTrialPeriodDays | Number | Number of trial period days |
isIncludingCountries | Boolean | Including countries |
pricingModelId | String | The ID of the pricing model for this product price |
pricingModels | Object | Object describing the pricing model |
billingTypesId | String | Billing type ID |
billingTypes | Array | An array of objects describing billing types |
recurringUsageTypesId | String | Recurring usage type ID |
recurringUsageTypes | Array | An array of objects describing recurring usage types |
billingPeriodId | String | Billing period ID |
billingPeriods | Array | An array of objects describing billing periods |
recurringMeteredUsageId | String | Recurring metered usage ID |
customIntervalCount | Number | Custom interval count |
recurringMeteredUsages | Array | An array of objects describing recurring metered usages |
currencyId | String | Currency ID |
currencies | Array | Array of Currency objects |
productPriceTiers | Array | Array of objects describing product price tiers. Used in the Graduated Pricing Model. |
metadata | Array | Any custom properties of the product price in the form of key-value pairs |
customRecurringIntervalsId | String | Custom recurring interval ID |
numberActiveSubscriptions | Number | Number of active subscriptions |
isActive | Boolean | If True, this product price is active |
onlyProductPrice | Boolean | If True, this is the only product price |
neverUsedSubscription | Boolean | If True, subscription has never been used |