Skip to main content
PATCH
/
prices
/
{price_id}
Update Price
curl --request PATCH \
  --url https://api.atlas.co/functions/v1/prices/{price_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>",
  "is_active": true,
  "metadata": {}
}
'
{
  "id": "<string>",
  "object": "price",
  "product": "<string>",
  "active": true,
  "currency": "<string>",
  "unit_amount": 123,
  "type": "one_time",
  "billing_scheme": "per_unit",
  "recurring": {
    "interval": "<string>",
    "interval_count": 123,
    "usage_type": "<string>",
    "aggregate_usage": "<string>"
  },
  "tiers": [
    {}
  ],
  "tiers_mode": "<string>",
  "nickname": "<string>",
  "metadata": {},
  "created": 123
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Path Parameters

price_id
string
required

Body

application/json
nickname
string
is_active
boolean
metadata
object

Response

Price updated

id
string
object
enum<string>
Available options:
price
product
string
active
boolean
currency
string
unit_amount
integer
type
enum<string>
Available options:
one_time,
recurring
billing_scheme
enum<string>
Available options:
per_unit,
tiered
recurring
object
tiers
object[]
tiers_mode
string
nickname
string
metadata
object
created
integer