logo

Coupon issuedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Coupon webhook request body resource.

couponId
string

ID of the coupon.

eventType
string

Type of webhook event.

Enum: "coupon-expiration-modified" "coupon-expired" "coupon-issued" "coupon-modified"
object

Embedded objects.

object (Coupon)

Coupons and discounts.

required
object (Discount)

Coupon discount.

issuedTime
required
string <date-time>

Date and time when the coupon is issued. This value may also be described as start time of the coupon.

id
string <= 50 characters

ID of the coupon. This value is also known as the coupon redemption code.

Array of objects (CouponRestriction)

Coupon restrictions.

redemptionsCount
integer >= 0

Total number of times that a coupon is redeemed.

status
string

Specifies the current status of the coupon.

Enum: "draft" "issued" "expired"
description
string

Description of the coupon. Use this field to provide an invoice discount item description.

If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".

expiredTime
string or null <date-time>

Date and time when the coupon expires.

revision
integer

Number of times the coupon data has been modified.

Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "coupon"
Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "couponId": "string",
  • "eventType": "coupon-expiration-modified",
  • "_embedded": {
    },
  • "_links": [
    ]
}
➔ Next to Coupon modified