Create
Authorizations
API key authentication
Body
Line item label shown on customer invoices. Sample values: 'Claude Token Consumption', 'Storage Usage (GB)', 'Inference API Calls', 'Image Generation Count', 'Training Compute Hours', 'Data Transfer (TB)'
Billing timing preference. For billable metrics: 'instant' (charges immediately) or 'in_arrears' (charges at period end). For fees: 'in_advance' (charges upfront) or 'in_arrears' (charges at period end).
instant, in_arrears, in_advance Standard pricing model
- Option 1
- Option 2
- Option 3
- Option 4
The unique identifier for the billable metric referred to by this price. Either billableMetricId or feeId must be provided.
^bm_[a-zA-Z0-9]+$The unique identifier for the fee referred to by this price. Either billableMetricId or feeId must be provided.
^fee_[a-zA-Z0-9]+$Denominate this metered price in a pricing unit (credits) instead of real currency. When set, the price draws down the customer's credit pool for that unit. Only valid on metered prices that carry a metered feature. Omit for a normal currency price.
^pu_[a-zA-Z0-9]+$Pricing calculation model. Required for billable metrics, optional for fees (defaults to 'standard'). Only 'standard' is accepted; for percentage/revenue-share use 'standard' with a unit-price multiplier. Legacy prices using 'dynamic'/'volume'/'percentage' stay readable and billable but cannot be created.
standard ISO 8601 duration for recurring charges (e.g., 'P1M' for monthly, 'P1Y' for yearly) or 'P0D' for one-time charges. Required for fees, optional for billable metrics. Sample values: 'P0D' for one-time, 'P1M' for monthly recurring, 'P1Y' for yearly recurring
Optional feature to associate with this price
When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
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 >= 0Response
Price created successfully
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.