Deactivate Price

POST

/api/:account_id/prices/:price_id/deactivate

POST

/api/:account_id/prices/:price_id/deactivate

$ curl -X POST https://app.paymentkit.com/api/account_id/prices/price_id/deactivate \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": "price_8f3b2c1d4a5e6f7g8h9i0j",
3   "account_id": "acct_1234567890abcdef",
4   "product_id": "prod_0987654321fedcba",
5   "name": "Premium Storage Monthly Plan",
6   "unit_amount_atom": 9990000,
7   "currency": "usd",
8   "is_active": false,
9   "unit_label": "GB",
10   "pricing_type": "recurring",
11   "recurring_interval": "month",
12   "recurring_interval_count": 1,
13   "auto_renew": false,
14   "contract_term_multiple": 1,
15   "trial_days": 14,
16   "usage_type": "licensed",
17   "metered_id": null,
18   "billing_scheme": "tiered",
19   "tier_amount_info": {
20     "mode": "volume",
21     "amount_atoms": [
22       {
23         "unit_amount_atom": 9990000,
24         "units_upto": 100,
25         "flat_amount_atom": 0
26       },
27       {
28         "unit_amount_atom": 8990000,
29         "units_upto": null,
30         "flat_amount_atom": 0
31       }
32     ]
33   },
34   "prerequisite_price_ids": [
35     "price_123abc456def789ghi"
36   ],
37   "exclusive_customer_ids": [
38     "cust_0011223344556677"
39   ],
40   "metadata": {
41     "region": "us-east-1",
42     "support_level": "premium"
43   },
44   "created_at": "2024-01-15T09:30:00Z",
45   "updated_at": "2024-04-20T16:45:00Z",
46   "product_name": "Premium Cloud Storage",
47   "product_description": "High-speed cloud storage with 99.9% uptime SLA",
48   "custom_fields": {
49     "internal_note": "Deactivated due to product update"
50   },
51   "quantity_divisor": 1,
52   "quantity_rounding": "ceil"
53 }

Deactivate an active price.

Authentication

AuthorizationBearer

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

Path parameters

price_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

account_idstring

product_idstring

namestring or null

unit_amount_atominteger or null

currencyenum

ISO 4217 currency codes.

is_activeboolean

unit_labelstring or null

pricing_typestring

recurring_intervalstring or null

recurring_interval_countinteger or null

auto_renewboolean or null

contract_term_multipleinteger or null

trial_daysinteger

usage_typestring

metered_idstring or null

billing_schemestring

tier_amount_infoobject or null

Tiered pricing configuration.

prerequisite_price_idslist of strings or null

exclusive_customer_idslist of strings or null

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

product_namestring or nullOptional

product_descriptionstring or nullOptional

custom_fieldsmap from strings to any or nullOptional

Custom field values. Only included when expand=custom_fields is specified.

quantity_divisorintegerOptionalDefaults to 1

quantity_roundingenumOptional

Rounding mode for fractional billable units in metered pricing.

CEIL (default): Round up to next whole unit — for packaged pricing
PROPORTIONAL: Keep exact fractions — for percentage-based fees (e.g., 0.65% of volume)
FLOOR: Round down to whole unit
ROUND: Standard rounding (0.5+ rounds up)

Errors

422

Unprocessable Entity Error