BillKit/Docs Console
Prices

Update price

Archive a price so it stops selling, or put it back on sale.

POST/v1/prices/{price_id}
Operation update_price · Scope prices:write · Spec snapshot 2026-09-13

Parameters

ParameterDescription
price_idstring · pathrequiredNo description in the spec.
activeboolean | nulloptionalNo description in the spec.
metadataobject | nulloptionalAt most 50 keys.
payment_methodsarray of enum | nulloptionalNo description in the spec.
refund_on_cancelenum | nulloptionalOne of none, full, prorated.
refund_window_initial_daysinteger | nulloptionalBetween 0 and 365.
refund_window_renewal_daysinteger | nulloptionalBetween 0 and 365.
tax_behaviorenum | nulloptionalOne of inclusive, exclusive.

Returns

Returns a PriceResponse object.

Errors

Status Cause
401 Missing or invalid API key.
403 Key is missing the prices:write scope.
404 No such object, or it belongs to the other mode.
422 Validation Error
429 Rate limited. Back off and retry.
Request · curl
curl -X POST https://api.billkit.eu/v1/prices/price_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Request body · every field
{
  "active": false,
  "metadata": {
    "key": "value"
  },
  "payment_methods": [
    "creditcard"
  ],
  "refund_on_cancel": "none",
  "refund_window_initial_days": 0,
  "refund_window_renewal_days": 0,
  "tax_behavior": "inclusive"
}
Response · 200 OK
{
  "active": false,
  "amount_cents": 1900,
  "billing_scheme": "string",
  "created": 1789392000,
  "currency": "EUR",
  "id": "price_9XKp2vQ1",
  "interval": "string",
  "livemode": false,
  "metadata": {
    "key": "value"
  },
  "object": "price",
  "payment_methods": [
    "string"
  ],
  "product_id": "prod_9XKp2vQ1",
  "product_name": "Ada Lovelace",
  "refund_on_cancel": "none",
  "refund_window_initial_days": 0,
  "refund_window_renewal_days": 0,
  "tax_behavior": "string",
  "tiers": [
    {
      "flat_amount": 1900,
      "unit_amount_decimal": "string",
      "up_to": 0
    }
  ],
  "tiers_mode": "string",
  "trial_days": 0,
  "trial_verification_cents": 1900,
  "unit_amount_decimal": "string",
  "usage_type": "string"
}