# Coupon expiration modified

Endpoint: POST coupon-expiration-modified
Version: latest
Security: SecretApiKey, JWT

## Request fields

- `couponId` (string)
  ID of the coupon.
- `eventType` (string)
  Type of event that triggered the webhook.
  Enum: "coupon-expiration-modified", "coupon-expired", "coupon-issued", "coupon-modified"
- `_embedded` (object)
  Embedded objects related to the coupon event.
- `_embedded.coupon` (object)
  Coupons and discounts.
- `_embedded.coupon.discount` (object, required)
  Coupon discount.
- `_embedded.coupon.restrictions` (array)
  Coupon restrictions. All `type` values in this array must be unique.
- `_embedded.coupon.restrictions.type` (string, required)
  Type of coupon restriction.
  Enum: "total-redemptions"
- `_embedded.coupon.restrictions.quantity` (integer, required)
  Permitted number of discounts per redemption.
- `_embedded.coupon.restrictions.amount` (number, required)
  Maximum order amount that is allowed to apply the coupon.
- `_embedded.coupon.restrictions.currency` (string, required)
  Currency code in ISO 4217 format.
  Example: USD
- `_embedded.coupon.restrictions.amount` (number, required)
  Minimum order quantity that is required to apply the coupon.
- `_embedded.coupon.restrictions.time` (string, required)
  Date and time when a coupon redemption is no longer valid, and the coupon is removed from unpaid invoices if applied. > **Note:** This date-time cannot be changed.
- `_embedded.coupon.restrictions.quantity` (integer, required)
  Permitted number of redemptions per customer.
- `_embedded.coupon.restrictions.buy` (array, required)
  One or more plan and quantity definitions that must be purchased to receive all plans and quantities that are defined in the `get` instruction. All `planId` values in this array must be unique.
- `_embedded.coupon.restrictions.buy.planId` (string, required)
  Plan ID of the item being purchased. This value must be unique within the `buy.items` array.
  Example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X
- `_embedded.coupon.restrictions.buy.quantity` (integer, required)
  Total quantity of the associated plan ID that must be purchased for this restriction to apply.
- `_embedded.coupon.restrictions.get` (array, required)
  One or more plan and quantity definitions that are added to a purchase if all definitions in the `buy` condition are met. All `planId` values in this array must be unique.
- `_embedded.coupon.restrictions.get.planId` (string, required)
  Plan ID of the item that is to be received by the customer. This value must be unique within the `get.items` array.
  Example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X
- `_embedded.coupon.restrictions.get.quantity` (integer, required)
  Total quantity of the associated plan ID that is to be received by the customer.
- `_embedded.coupon.restrictions.countries` (array, required)
  Countries where the coupon can be applied, in ISO Alpha-2 code format. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
- `_embedded.coupon.restrictions.tags` (array, required)
  Customer tags on which a coupon can be applied.
- `_embedded.coupon.restrictions.requireAllTags` (boolean, required)
  Specifies if the customer must have all listed tags, or at least one of the listed tags, to redeem a coupon.
  Enum: true, false
- `_embedded.coupon.restrictions.customerIds` (array, required)
  Customer IDs on which a coupon can be applied.
- `_embedded.coupon.restrictions.invoiceIds` (array, required)
  Invoice IDs on which a coupon can be applied.
- `_embedded.coupon.restrictions.planIds` (array, required)
  Plan IDs on which a coupon can be applied.
- `_embedded.coupon.restrictions.minimumQuantity` (integer)
  Minimum quantity that is required to apply the restriction and subsequent discount.
- `_embedded.coupon.restrictions.productIds` (array, required)
  Product IDs on which a coupon can be applied.
- `_embedded.coupon.restrictions.subscriptionIds` (array, required)
  Subscription IDs on which a coupon can be applied.
- `_embedded.coupon.restrictions.quantity` (integer, required)
  Permitted total number of redemptions.
- `_embedded.coupon.description` (string)
  Description of the coupon. Use this field to provide a description for the invoice discount item. If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: `Coupon "COUPON-ID"`.
- `_embedded.coupon.issuedTime` (string, required)
  Date and time when the coupon is issued. This value may also be described as start time of the coupon.
- `_embedded.coupon.expiredTime` (string | null)
  Date and time when the coupon expires.
- `_links` (array)
  Links to related resources.
- `_links.href` (string)
  URL of the link.
- `_links.rel` (string)
  Relationship type of the link.
  Enum: "coupon"