logo

Coupon redemption canceledWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Coupon redemption webhook request body resource.

couponId
string

ID of the coupon.

redemptionId
string

ID of the redemption.

customerId
string

ID of the customer.

eventType
string

Type of webhook event.

Enum: "coupon-application-removed" "coupon-applied" "coupon-redeemed" "coupon-redemption-canceled"
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.

object (CouponRedemption)

Coupon redemption log.

id
string <= 50 characters

Unique resource ID.

couponId
string <= 50 characters

ID of the coupon.

customerId
string (CustomerId) <= 50 characters

ID of the customer resource.

Array of objects (RedemptionRestriction)

Additional coupon redemption restrictions.

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.

canceledTime
string or null <date-time>

Date and time when the coupon is canceled.

Array of objects

Related links.

object (Customer)

Customer information.

id
string <= 50 characters

ID of the customer.

email
string or null <email>

Customer's email address.

firstName
string or null

Customer's first name.

lastName
string or null

Customer's last name.

websiteId
string <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

(Vaulted instrument (object or null)) or (Alternative instrument (object or null)) or (Cash (object or null)) or (Check (object or null))

Default payment instrument information.

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.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

object or null

Customer's primary address.

object or null (Company)

Company information that is associated with the customer's primary email address domain.

This is a paid feature, to enable it contact Rebilly.

object (CustomerAverageValue)

Average customer value.

paymentCount
integer

Total number of approved payments made by the customer.

lastPaymentTime
string or null <date-time>

Time and date of the customer's last approved payment.

object (CustomerLifetimeRevenue)

Customer's lifetime revenue.

invoiceCount
integer

Total number of invoices issued to the customer. This value is auto-incrementing. If this value is 0, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to 1 the record relates to a customer.

Array of objects (Tag)

List of customer tags.

revision
integer

Number of times the customer's data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

isEddRequired
boolean
Default: false

Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.

hasFulfilledKyc
boolean

Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of objects or null (TaxNumber)

Tax numbers of the customer.

Array of objects

Related links.

object

Embedded objects that are requested using the expand query string parameter.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "coupon" "redemption" "customer"
Responses
2xx

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

Request samples
application/json
{
  • "couponId": "string",
  • "redemptionId": "string",
  • "customerId": "string",
  • "eventType": "coupon-application-removed",
  • "_embedded": {
    },
  • "_links": [
    ]
}
➔ Next to Quotes