# Coupon redeemed

Endpoint: POST coupon-redeemed
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `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"

  - `_embedded` (object)
    Embedded objects.

  - `_embedded.coupon` (object)
    Coupons and discounts.

  - `_embedded.coupon.discount` (any, required)

  - `_embedded.coupon.restrictions` (array)
    Coupon restrictions. All  values in this array must be unique.

  - `_embedded.coupon.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:
.

  - `_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.

  - `_embedded.redemption` (object)
    Coupon redemption log.

  - `_embedded.redemption.customerId` (string)
    ID of the customer resource.

  - `_embedded.redemption.additionalRestrictions` (array)
    Additional coupon redemption restrictions.

  - `_embedded.customer` (object)
    Customer information.

  - `_embedded.customer.websiteId` (string)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

  - `_embedded.customer.paymentToken` (string)
    Write-only payment token.
If supplied, the token is converted into a payment instrument and set as the  value.
If both are supplied, the value of this property overrides the  value.
The token expires after first use.

  - `_embedded.customer.defaultPaymentInstrument` (object,null)

  - `_embedded.customer.preferredPayoutInstrumentId` (string,null)
    ID of the customer's preferred payment instrument for payouts.
    Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `_embedded.customer.customFields` (object)
    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](https://www.rebilly.com/catalog/all/custom-fields).

  - `_embedded.customer.primaryAddress` (any)
    Customer's primary address.

  - `_embedded.customer.isEddRequired` (boolean)
    Specifies if Enhanced Due Diligence (EDD) is enabled for this customer.
For more information, see [Enhanced Due Diligence](https://www.rebilly.com/docs/kyc-and-aml/edd/).

  - `_embedded.customer.locale` (string,null)
    Language locale identifier in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
    Example: "fr-FR"

  - `_embedded.customer.taxNumbers` (array,null)
    Tax numbers of the customer.

  - `_embedded.customer.taxNumbers.type` (string, required)
    Type of the tax number.
    Enum: "eu-vat", "other"

  - `_embedded.customer.taxNumbers.value` (string, required)
    Value of the tax number.
    Example: "GB980780684"

  - `_embedded.customer.taxNumbers.isDefault` (boolean)
    Determines if the tax number is selected as default to display on invoices.
    Example: true

  - `_embedded.customer.leadSource` (object)
    Lead source information.

  - `_embedded.customer.leadSource.medium` (string,null)
    Category of the lead source traffic.
For example, the medium could be organic search, Google ads, Display ads, and so on.

  - `_embedded.customer.leadSource.source` (string,null)
    Domain, platform, or channel from which the lead source originates.

  - `_embedded.customer.leadSource.campaign` (string,null)
    Campaign name of the lead source.

  - `_embedded.customer.leadSource.term` (string,null)
    Term associated with a lead source.

  - `_embedded.customer.leadSource.content` (string,null)
    Content contained in the lead source content.
For example, content could be graphics, video, and so on.

  - `_embedded.customer.leadSource.affiliate` (string,null)
    Individual or entity that is affiliated with the lead source.

  - `_embedded.customer.leadSource.subAffiliate` (string,null)
    Individual or entity that is associated with a lead source affiliate.
In other products, this field may also be referred to as sub ID or click ID in some.

  - `_embedded.customer.leadSource.salesAgent` (string,null)
    Name of the sales agent associated with the lead source.

  - `_embedded.customer.leadSource.clickId` (string,null)
    ID of the lead source click.
This value is passed in the ad click URL for tracking and campaign attribution.

  - `_embedded.customer.leadSource.path` (string,null)
    URL from which the lead source originates.

  - `_embedded.customer.leadSource.referrer` (string,null)
    Lead source [ URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "coupon", "redemption", "customer"