SEsellauth
Coupons

Get Coupon

Changed on

Retrieves a specific coupon.

get/v1/shops/{shopId}/coupons/{couponId}

Request

Response

idinteger
codestring
saltstring
globalboolean
discountstring
usesinteger
max_usesstring nullable
max_uses_per_customerstring nullable
min_invoice_pricestring nullable
allowed_emailsstring nullable
payment_method_idsstring nullable
disable_if_volume_discountboolean
disable_if_bundle_offerboolean
disable_if_quantity_dealboolean
disable_if_gateway_discountboolean
disable_if_affiliate_discountboolean
disable_if_reseller_discountboolean
uses_count_modestring
typestring
start_datestring nullable
expiration_datestring nullable
shop_idinteger
created_atstring
updated_atstring
applies_to_renewalsboolean

Example response

{
  "id": 1,
  "code": "SAVE10",
  "salt": "54260227e2949",
  "global": true,
  "discount": "10.00",
  "uses": 0,
  "max_uses": null,
  "max_uses_per_customer": null,
  "min_invoice_price": null,
  "allowed_emails": null,
  "payment_method_ids": null,
  "disable_if_volume_discount": false,
  "disable_if_bundle_offer": false,
  "disable_if_quantity_deal": false,
  "disable_if_gateway_discount": false,
  "disable_if_affiliate_discount": false,
  "disable_if_reseller_discount": true,
  "uses_count_mode": "pending",
  "type": "percentage",
  "start_date": null,
  "expiration_date": null,
  "shop_id": 1,
  "created_at": "2026-11-01T20:00:51.000000Z",
  "updated_at": "2026-11-01T20:00:51.000000Z",
  "applies_to_renewals": false,
  "items": []
}

Changes

  • ff0d59c98d7aRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

  • 5cbdf10d05abRevision changes
    • info

      added the optional property to the response with the status