Pending Discount — XPay docs

A Discount selected for a Checkout Session before payment completes. Its ID is pending until the discount is redeemed, and it includes the selected Coupon and any Promotion Code used.

id*"pending"

Value in

"pending"

object*"discount"

Object type

Value in

"discount"

coupon*

The Coupon selected for a Checkout Session before payment completes. It contains the discount terms used to calculate the session total; the Coupon has not yet been redeemed.

promotionCodeId?string|null

promotionCodeCode?string|null

checkoutSessionId*string

Checkout session this discount was applied to

customerId?string

Customer who received the discount

start*string

When the discount became active (ISO 8601)

end?string

When the discount ends (ISO 8601)

{  "id": "pending",  "object": "discount",  "coupon": {    "id": "string",    "object": "coupon",    "name": "string",    "discountType": "string",    "percentOff": 0,    "amountOff": "string",    "currency": "string",    "valid": true,    "livemode": true  },  "promotionCodeId": "string",  "promotionCodeCode": "string",  "checkoutSessionId": "string",  "customerId": "string",  "start": "string",  "end": "string"}