Update a usage-based billing

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint allows you to update an existing usage-based billing product. You can modify various attributes of the product to adjust its pricing, measurement units, or other characteristics.

Usage Guidelines

  1. Retrieve the current product data: Before updating, use the "get" endpoint to retrieve the full set of current product data.
  2. Modify only necessary fields: When submitting the update request, include all fields from the "get" response, changing only those that require updates.
  3. Consistent data structure: Ensure that the update request maintains the same data structure as the "get" response.

Important Notes

  • Fixed pricing strategy: Subscription usage-based billing products created with a fixed pricing strategy will not be affected by updates.

Related Endpoints

Path Params
string
required
length ≥ 1

uuid or handle of the usage-based billing

Body Params
string
required
length ≥ 1

Name of usage-based billing product.

string

Optional description of usage-based billing product

entitlements
array of strings

Entitlements for this usage-based billing product.

entitlements
pricing
object
required

Pricing for this usage-based billing product.

boolean

Whether all plans are eligible for this usage-based billing product. Defaults to false.

string
required
length ≥ 1

The method used to capture usage for this usage-based billing product.

boolean

Automatically add this product to a subscription when usage is recorded.

string
enum

Source used to derive invoice service period for metered invoice lines. record_created is deprecated and will be removed by 2026-08-01.

Allowed:
boolean

Whether a metered usage order line with amount = 0 should be included in the invoice. Omitted values leave the existing setting unchanged.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json