v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB

Plan Overrides

Create a plan override

Create a customer-specific override for a plan (custom pricing, minimum commitment, or charge properties)

post/api/plan-overrides

Request body

customerIdstring required

Customer ID

planIdstring required

Plan ID

overriddenPricesstring[]

Override plan prices: array of { currency, amount }

overriddenMinimumCommitmentnumber

Override minimum commitment amount

overriddenChargesstring[]

Override charge properties: array of { chargeId, properties?, graduatedRanges? }

metadataobject

Custom metadata

Example request

{
  "customerId": "clx_customer_123",
  "planId": "clx_plan_456",
  "overriddenPrices": [
    {
      "currency": "USD",
      "amount": 49.99
    }
  ],
  "overriddenMinimumCommitment": 500,
  "overriddenCharges": [
    {
      "chargeId": "clx_charge_789",
      "properties": {
        "amount": 0.05
      }
    }
  ]
}

Response

Plan override created

idstring required

customerIdstring required

planIdstring required

overriddenPricesobject

overriddenMinimumCommitmentnumber

overriddenChargesobject

metadataobject

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "id": "clx1234567890",
  "customerId": "clx_customer_123",
  "planId": "clx_plan_456",
  "overriddenMinimumCommitment": 500
}