Sign in

v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Billing

Update plan (mutable fields)

Only name, description, sku, unit_label and metadata are mutable. To change pricing, archive the plan and create a new one.

put/plans/{id}/

Request body

namestring
descriptionstring
skustring nullable
unit_labelstring nullable
metadataobject

Response

Updated plan.

idstring
productstring required

Product ID.

skustring nullable
namestring required
descriptionstring required
frequencystring required

Frequency ID (e.g. monthly).

currencystring required

ISO currency code.

amountnumber required
exemptboolean
usage_scheme'licensed' | 'metered'
usage_aggregation'last_record' | 'max' | 'sum' nullable
tiers_mode'package' | 'volume' | 'graduated' | 'package_overage' | 'unit' | 'range' nullable

Pricing mode for tiered plans. unit and range are deprecated aliases of volume and package respectively.

unit_labelstring nullable
status'active' | 'archived'
archivedstring date-time nullable
createdstring date-time
updatedstring date-time