Get
Authorizations
API key authentication
Path Parameters
The unique identifier of the price Unique identifier for a price
^price_[a-zA-Z0-9]+$Response
Price details
Unique identifier for a price
^price_[a-zA-Z0-9]+$price The merchant organization that owns this price, derived from the associated fee or billable metric. Present on single-price reads.
^org_[a-zA-Z0-9]+$instant, in_arrears, in_advance Standard pricing model
- Option 1
- Option 2
- Option 3
- Option 4
Quantity for invoice line items. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
x >= 0Unique identifier for a billable metric
^bm_[a-zA-Z0-9]+$The unique identifier for the fee referred to by this price. Present when price is linked to a fee.
^fee_[a-zA-Z0-9]+$The pricing unit this price is denominated in (credits). Present when the price draws down a credit pool instead of charging real currency.
^pu_[a-zA-Z0-9]+$ISO 8601 duration. 'P0D' for one-time, 'P1M' for monthly, 'P1Y' for yearly. Required for fees, optional for billable metrics. Defaults to plan's billingCadence if not specified.
Pricing model of a price as returned by the API. Includes legacy models ('dynamic', 'volume', 'percentage') retained for existing prices; only 'standard' can be created (see PriceModelInput).
standard, dynamic, volume, percentage Features associated with this price
When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.