order APIv1_beta.29.1

Coupon

The type that defines the fields for the coupon information.

Note: This container is not returned for the getPurchaseOrder and getGuestPurchaseOrder methods.

Types that use Coupon

CheckoutSessionResponse,GuestCheckoutSessionResponse,GuestPurchaseOrder,PurchaseOrder

Calls that use Coupon

POST
/checkout_session/{checkoutSessionId}/apply_coupon
GET
/checkout_session/{checkoutSessionId}
POST
/checkout_session/initiate
POST
/checkout_session/{checkoutSessionId}/remove_coupon
POST
/checkout_session/{checkoutSessionId}/update_payment_info
POST
/checkout_session/{checkoutSessionId}/update_quantity
POST
/checkout_session/{checkoutSessionId}/update_shipping_address
POST
/checkout_session/{checkoutSessionId}/update_shipping_option
POST
/guest_checkout_session/{checkoutSessionId}/apply_coupon
POST
/guest_checkout_session/{checkoutSessionId}/remove_coupon
POST
/proxy_guest_checkout_session/{checkoutSessionId}/apply_coupon
POST
/proxy_guest_checkout_session/{checkoutSessionId}/remove_coupon
GET
/guest_checkout_session/{checkoutSessionId}
POST
/guest_checkout_session/initiate
POST
/guest_checkout_session/{checkoutSessionId}/initiate_payment
POST
/guest_checkout_session/{checkoutSessionId}/update_payment_info
POST
/guest_checkout_session/{checkoutSessionId}/update_quantity
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_address
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_option
GET
/proxy_guest_checkout_session/{checkoutSessionId}
POST
/proxy_guest_checkout_session/initiate
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_payment_info
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_quantity
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_option
GET
/guest_purchase_order/{purchaseOrderId}
GET
/purchase_order/{purchaseOrderId}

Fields

Field
Type
Description
redemptionCode
string
The coupon redemption code.