SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Products and Subscriptions

Switch a discount code off

Stop a code being used. Subscriptions that already use it keep their discount.

POSThttps://app.softsolz.uk/api/v1/services/catalog/catalog/coupons/{id}/retire

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Response

Response Body

idstringDiscount code id.
codestringThe code customers enter.
descriptionstring | nullInternal note about the code.
discount_typestringA percentage off, or a fixed amount off.
percent_offnumber | nullPercentage off, 1 to 100. Null for an amount discount.
amount_off_centsinteger | nullAmount off in minor units. Null for a percentage discount.
currencystring | nullCurrency of an amount discount, stored in capitals (gbp becomes GBP).
max_redemptionsinteger | nullHow many times the code can be used in total. Null for no limit.
redeemed_countintegerHow many times the code has been used.
starts_atstring | nullWhen the code starts working.
expires_atstring | nullWhen the code stops working.
activebooleanWhether the code is switched on.
redeemablebooleanWhether the code can be used right now: on, started, not expired and under its limit.
created_atstringWhen the code was created.
updated_atstringWhen the code last changed.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/catalog/catalog/coupons/{id}/retire \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "id": "5",
    "code": "WELCOME10",
    "description": "Ten percent off for new customers.",
    "discount_type": "percent",
    "percent_off": 10,
    "amount_off_cents": null,
    "currency": null,
    "max_redemptions": 100,
    "redeemed_count": 12,
    "starts_at": null,
    "expires_at": "2026-12-31T23:59:59.000Z",
    "active": true,
    "redeemable": true,
    "created_at": "2026-10-01T09:00:00.000Z",
    "updated_at": "2026-10-01T09:00:00.000Z"
  }
}