End a customer price override
const url = 'http://localhost:8080/v1/price-overrides/example';const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url http://localhost:8080/v1/price-overrides/example \ --header 'Authorization: Bearer <token>'Marks the override inactive. The row is kept. The customer goes back to the price’s rate from its next billing period, in the customer’s time; the current period keeps the rate it started with. A subscription of the customer that first joins the plan in a period after the override ends (a new subscription, an immediate plan change, an added item) pays the price’s rate from the join.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The override, now with active false.
A customer’s negotiated rate for one plan price. It keeps applying when the price’s rate changes, and ends when the price is removed. It takes the plan’s currency.
object
The plan price this override replaces the rate of, for this customer.
As on PriceShape.
Price per unit in cents, as a decimal string.
Empty ([]) unless mode is graduated.
object
The tier’s upper bound in whole units: the tier prices the quantity above the previous tier’s bound, up to this one. null on the last tier, which has no upper bound. Only the last tier is null, and it must be.
Price per unit in cents in this tier, as a decimal string.
Price of one package in cents, as a decimal string.
When the override starts, in the customer’s time: wall time, or its test clock’s time. A subscription already on the plan gets it from its next period; one that first joins the plan in a period after this instant gets it from the join.
When the override ended, in the customer’s time. Absent while it is active.
Example
{ "id": "hc_cpo_1a2b3c4d5e6f7890", "mode": "per_unit"}not_found: no active override with this id (it may already be ended).
object
object
One of invalid_request_error, authentication_error,
rate_limit_error or api_error. Every error the API
answers has this shape, including an unknown path (404,
code route_not_found) and a method the path does not take
(405, code method_not_allowed, with an Allow header).
The few exceptions are listed in docs/api-surface.md.
The request field the error is about. Sent only when the error
names one. A request body may hold only the fields its
operation lists, spelled and cased as listed: any other
field, or one the server sets (such as id), is refused
with 422 and param naming it. An operation with no request body lists no fields: send
no body, {} or null. The Stripe and Postmark webhooks and
the LiteLLM callback take their sender’s body as it comes.
Example
{ "error": { "type": "invalid_request_error" }}