Price
List prices
This endpoint is used to list all add-on prices created using the price creation endpoint.
GET
List prices
Query Parameters
Response
OK
data
(UnitPrice · object | TieredPrice · object | BulkPrice · object | BulkWithFiltersPrice · object | PackagePrice · object | MatrixPrice · object | ThresholdTotalAmountPrice · object | TieredPackagePrice · object | TieredWithMinimumPrice · object | GroupedTieredPrice · object | GroupedTieredMatrixPrice · object | TieredPackageWithMinimumPrice · object | PackageWithAllocationPrice · object | UnitWithPercentPrice · object | MatrixWithAllocationPrice · object | TieredMatrixWithAllocationPrice · object | MatrixWithThresholdDiscountsPrice · object | TieredWithProrationPrice · object | UnitWithProrationPrice · object | GroupedAllocationPrice · object | BulkWithProrationPrice · object | GroupedWithProratedMinimumPrice · object | GroupedWithMeteredMinimumPrice · object | GroupedWithMinMaxThresholdsPrice · object | MatrixWithDisplayNamePrice · object | GroupedTieredPackagePrice · object | MaxGroupTieredPackagePrice · object | ScalableMatrixWithUnitPricingPrice · object | ScalableMatrixWithTieredPricingPrice · object | CumulativeGroupedBulkPrice · object | CumulativeGroupedAllocationPrice · object | DailyCreditAllowancePrice · object | MeteredAllowancePrice · object | MinimumCompositePrice · object | PercentCompositePrice · object | EventOutputPrice · object | UnitWithMultiplierPrice · object)[]
required
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
For more on the types of prices, see the core concepts documentation
- UnitPrice
- TieredPrice
- BulkPrice
- BulkWithFiltersPrice
- PackagePrice
- MatrixPrice
- ThresholdTotalAmountPrice
- TieredPackagePrice
- TieredWithMinimumPrice
- GroupedTieredPrice
- GroupedTieredMatrixPrice
- TieredPackageWithMinimumPrice
- PackageWithAllocationPrice
- UnitWithPercentPrice
- MatrixWithAllocationPrice
- TieredMatrixWithAllocationPrice
- MatrixWithThresholdDiscountsPrice
- TieredWithProrationPrice
- UnitWithProrationPrice
- GroupedAllocationPrice
- BulkWithProrationPrice
- GroupedWithProratedMinimumPrice
- GroupedWithMeteredMinimumPrice
- GroupedWithMinMaxThresholdsPrice
- MatrixWithDisplayNamePrice
- GroupedTieredPackagePrice
- MaxGroupTieredPackagePrice
- ScalableMatrixWithUnitPricingPrice
- ScalableMatrixWithTieredPricingPrice
- CumulativeGroupedBulkPrice
- CumulativeGroupedAllocationPrice
- DailyCreditAllowancePrice
- MeteredAllowancePrice
- MinimumCompositePrice
- PercentCompositePrice
- EventOutputPrice
- UnitWithMultiplierPrice