v1
latestOpenAPI 3.1.02026-07-2684271522.2 KBPrices
Update Price
Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged. Only description and active can be updated; the unit amount, currency, and recurring interval of a price are immutable. Setting active to false archives the price so it can no longer be used for new purchases.
post/v1/prices/{id}
Path parameters
idstring required
Example:fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA
Request body
Example request
{
"price": {
"description": "Premium SPF 50 mineral sunscreen",
"active": false
}
}Response
An envelope wrapping a single price object.
Example response
{
"price": {
"price_id": "fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"description": "Premium SPF 50 mineral sunscreen",
"unit_amount": 0,
"recurring": {},
"active": false,
"product": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"created_at": "2026-06-15T14:30:00Z",
"type": "one_time",
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"hsa_fsa_eligibility": "not_eligible",
"test_mode": false
}
}