Deactivate Coupon

POST

/api/:account_id/coupons/:coupon_id/deactivate

POST

/api/:account_id/coupons/:coupon_id/deactivate

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

1 {
2   "id": "c9f1a7d2-4b3e-4f6a-9d2e-8a7b3c5d9f01",
3   "status": "deactivated",
4   "name": "Spring Sale 2024",
5   "discount_type": "percent_off",
6   "amount_atom_off": null,
7   "percent_off": 15,
8   "trial_days_off": null,
9   "currency": "usd",
10   "duration": "once",
11   "duration_in_months": null,
12   "max_redemptions": 100,
13   "redemption_count": 45,
14   "valid_from": "2024-01-01T00:00:00Z",
15   "valid_until": "2024-03-31T23:59:59Z",
16   "validity_period_days": null,
17   "products": [
18     "prod_12345"
19   ],
20   "metadata": {
21     "created_by": "admin_user",
22     "notes": "Deactivated due to campaign end"
23   },
24   "created_at": "2023-12-15T12:00:00Z",
25   "updated_at": "2024-02-15T10:00:00Z",
26   "promotion_code_count": 5,
27   "product_details": [
28     {
29       "id": "prod_12345",
30       "name": "Premium Subscription"
31     }
32   ]
33 }

Manually deactivate an active coupon.

Authentication

AuthorizationBearer

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

Path parameters

coupon_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

statusstring

namestring or null

discount_typestring

amount_atom_offinteger or null

percent_offdouble or null

trial_days_offinteger or null

currencyenum or null

ISO 4217 currency codes.

durationstring

duration_in_monthsinteger or null

max_redemptionsinteger or null

redemption_countinteger

valid_fromdatetime or null

valid_untildatetime or null

validity_period_daysinteger or null

productslist of strings

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

promotion_code_countintegerOptionalDefaults to 0

product_detailslist of objectsOptional

Errors

422

Unprocessable Entity Error