UpdatePriceRequest

Only active, nickname and metadata can change. Any other field is rejected: to change the amount, the currency or the billing period, create a new price.

activePrice-Active

Whether the price is active. An inactive price cannot start a subscription, and a subscription cannot switch to it. Prices are never deleted: set active to false to archive one. Subscriptions that already use it keep their copy of its values.

Default value: true

Example: true

nicknamePrice-Nickname

An internal label of the price. Buyers never see it.

Possible values: <= 100 characters

Example: Monthly

metadataobject

A set of key-value pairs that you can attach to a resource. This can be useful for storing additional information about the resource in a structured format.

Example: {"systemId":"12345"}

UpdatePriceRequest

{
  "active": true,
  "nickname": "Monthly",
  "metadata": {
    "systemId": "12345"
  }
}