Update price
Use when changing price configuration (e.g. amount, billing scheme, or metadata).
Path parameters
Price ID
Request body
Amount is the new price amount that overrides the original price (optional)
GroupID is the id of the group to update the price in. If not provided (nil), the group will not be changed If provided as empty string (""), the group will be removed (price will be ungrouped) If provided as a group ID, the price will be assigned to that group (must exist and be published)
All price fields that can be updated Non-critical fields (can be updated directly)
PriceUnitAmount is the price unit amount (for CUSTOM price unit type, FLAT_FEE/PACKAGE billing models)
Response
OK
Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50
BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12
ConversionRate is the conversion rate of the price unit to the fiat currency
Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp
Description of the price
DisplayAmount is the formatted amount with currency symbol For USD: $12.50
DisplayName is the name of the price
DisplayPriceUnitAmount is the formatted amount of the price unit
EndDate is the end date of the price
EntityID holds the value of the "entity_id" field.
EnvironmentID is the environment identifier for the price
GroupID references the group this price belongs to
ID uuid identifier for the price
LookupKey used for looking up the price in the database
MeterID is the id of the meter for usage based pricing
MinQuantity is the minimum quantity of the price
ParentPriceID references the root price (always set for price lineage tracking)
PriceUnit is the code of the price unit (e.g., 'btc', 'eth')
PriceUnitAmount is the amount of the price unit
PriceUnitID is the id of the price unit (for CUSTOM type)
Sequence is the monotonic stamp bumped on every state change that subscription line items need to react to. Read by the plan-price sync; set by the database (DEFAULT nextval) on create and by the price repository on termination / compatibility-affecting edits.
StartDate is the start date of the price
TrialPeriodDays is the number of days for the trial period Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)