Backend API: Delete a coupon

Delete a coupon permanently.

Arguments

idobjectIdrequired

The ID of the coupon to delete.

DELETE/coupons/:id

const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');

await swell.delete('/coupons/{id}', {
  id: '60f199509111e70000000021'
});

Response

{
  "id": "60f199509111e70000000021",
  "name": "10% Off Winter Jacket Sale",
  "active": true,
  "codes": [
    {
      "code": "WINTER10"
    }
  ],
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.100Z",
  "date_expired": "2018-03-01T00:00:00.000Z",
  "date_updated": "2021-07-16T14:36:00.100Z",
  "date_valid": "2018-11-01T00:00:00.000Z",
  "description": "Save 10% on all Winter Jackets for a limited time only.",
  "discount_group": null,
  "discounts": [
    {
      "type": "category",
      "category_id": "5a97242bc65396a875c2d381",
      "value_type": "percent",
      "value_fixed": 10
    }
  ],
  "limit_account_uses": 3,
  "limit_code_uses": 10,
  "limit_uses": 300,
  "multi_codes": false,
  "use_count": 184
}