Update

Update

curl --request PATCH \
  --url https://{defaultHost}/v1/prices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "price": {
    "name": "Updated Price"
  }
}
'

{
  "id": "f61eadc0-a05f-4753-ba65-ff67e632091c",
  "object": "price",
  "ad_hoc": false,
  "ad_hoc_max_amount": null,
  "ad_hoc_min_amount": 0,
  "amount": 2900,
  "archived": false,
  "archived_at": null,
  "currency": "usd",
  "current_version": true,
  "full_amount": 2900,
  "license_activation_limit": null,
  "metadata": {},
  "name": "Updated Price",
  "position": 0,
  "portal_subscription_update_enabled": true,
  "restart_subscription_on_completed": false,
  "revoke_after_days": null,
  "revoke_purchases_on_completed": false,
  "recurring_interval": null,
  "recurring_interval_count": null,
  "recurring_period_count": null,
  "scratch_amount": null,
  "setup_fee_amount": 0,
  "setup_fee_enabled": false,
  "setup_fee_trial_enabled": true,
  "setup_fee_name": null,
  "trial_duration_days": null,
  "current_swap": null,
  "product": "782ecee4-7f3b-4ee9-ac97-f6d561d56948",
  "renewal_price": null,
  "discarded_at": null,
  "created_at": 1767909734,
  "updated_at": 1767909734
}

PATCH

prices

{id}

Update

curl --request PATCH \
  --url https://{defaultHost}/v1/prices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "price": {
    "name": "Updated Price"
  }
}
'

{
  "id": "f61eadc0-a05f-4753-ba65-ff67e632091c",
  "object": "price",
  "ad_hoc": false,
  "ad_hoc_max_amount": null,
  "ad_hoc_min_amount": 0,
  "amount": 2900,
  "archived": false,
  "archived_at": null,
  "currency": "usd",
  "current_version": true,
  "full_amount": 2900,
  "license_activation_limit": null,
  "metadata": {},
  "name": "Updated Price",
  "position": 0,
  "portal_subscription_update_enabled": true,
  "restart_subscription_on_completed": false,
  "revoke_after_days": null,
  "revoke_purchases_on_completed": false,
  "recurring_interval": null,
  "recurring_interval_count": null,
  "recurring_period_count": null,
  "scratch_amount": null,
  "setup_fee_amount": 0,
  "setup_fee_enabled": false,
  "setup_fee_trial_enabled": true,
  "setup_fee_name": null,
  "trial_duration_days": null,
  "current_swap": null,
  "product": "782ecee4-7f3b-4ee9-ac97-f6d561d56948",
  "renewal_price": null,
  "discarded_at": null,
  "created_at": 1767909734,
  "updated_at": 1767909734
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

price

object

Show child attributes

Response

200 - application/json

Success

string | null

The UUID of the specific object.

object

string

A string describing the object type returned.

ad_hoc

boolean

default:false

Whether or not this price accepts ad hoc amounts – also known as custom or user-defined amounts.

ad_hoc_max_amount

integer | null

The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example 9900 is equivalent to $99.

ad_hoc_min_amount

integer | null

The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example 9900 is equivalent to $99. If left blank, this will be interpreted as 0.

amount

integer | null

The amount in cents to be charged, represented as a whole integer. For example 9900 is equivalent to $99. If ad_hoc=true the amount is optional.

archived

boolean

Whether or not this price is archived.

license_activation_limit

integer | null

The max number of activations allowed per license. If null, this value will inherit from the value set on Product.

name

string | null

The price name, meant to be displayable to the customer.

portal_subscription_update_enabled

boolean

Whether existing subscriptions can be switched to this price from the customer dashboard. If set to false, existing subscriptions cannot be switched to this price, preventing customers from upgrading or downgrading their subscription to this price option.

position

integer | null

The ordering position of this price when displayed to customers.

recurring_interval

string | null

The frequency at which a subscription is billed. One of day, week, month, or year. Only applicable during creation.

recurring_interval_count

integer | null

The number of intervals (specified in the recurring_interval attribute) between subscription billings. For example, recurring_interval=month and recurring_interval_count=3 bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.

recurring_period_count

integer | null

The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the complete state. Only applicable during creation.

revoke_after_days

integer | null

The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.

revoke_purchases_on_completed

boolean

Whether or not purchases for this price should be revoked when subscriptions transition to the complete state.

restart_subscription_on_completed

boolean

Whether installment subscriptions using this price should be automatically restarted when they reach the completed state.

setup_fee_amount

integer | null

The amount in cents to be charged as a setup fee on the first billing period of a recurring price.

setup_fee_enabled

boolean

Whether or not this price has a setup fee.

setup_fee_name

string | null

The name that will display for the setup fee on the first billing period.

setup_fee_trial_enabled

boolean

Whether or not the setup fee should be deferred until the trial period ends. If set to true, the setup fee will not be charged until the trial period ends.

scratch_amount

integer | null

The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.

trial_duration_days

integer | null

The default number of trial days when subscribing a customer to this price.

metadata

object

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

archived_at

integer | null

Time at which the object was archived. Measured in seconds since the Unix epoch.

currency

string

Three-letter ISO currency code, in lowercase. This value will match the Account currency.

full_amount

integer

The full amount to be charged across all periods, represented as a whole integer. For prices without a recurring_period_count defined this is the same as amount. For finite prices, this is equal to amount * recurring_period_count. For example, a price that has an amount of $25 and is set to recur over 4 periods, will have a full_amount of $100.

current_version

boolean

Whether or not this object represents the current version of this price. (This will be false if the association was created to this price before it was altered. In this case, we will lookup the version of the price at the time it was associated.)

current_swap

The current swap for this price.

Expandable – The associated swap ID.

product

Expandable – The associated product ID.

renewal_price

If present, subscriptions will be updated to this price when they renew.

Expandable – The associated price ID.

discarded_at

integer | null

Time at which the object was discarded. Measured in seconds since the Unix epoch.

created_at

integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at

integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.

Delete Duplicate

⌘I

Overview

Core Endpoints

Customers

Products

Orders & Payments

Subscriptions

Shipping & Fulfillment

Tax

Affiliates

Licensing

Public Endpoints

Authorizations

Path Parameters

Body

Response