Skip to main content
GET
Retrieve Discount

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

discount_amount
integer

The total discount amount applied to the associated checkout.

primary
boolean

Whether or not this discount is a primary or secondary discount. Primary discounts are the first discount in a series of discounts when the associated coupon can be used multiple times. Secondary discounts are the subsequent discounts in the series.

redeemable_status
string

The status indicating if this discount can be redeemed (finalized with) or not and why. Possible values are invalid, gone, expired, less_than_min_subtotal_amount, greater_than_max_subtotal_amount,not_applicable,not_applicable_to_customer, orredeemable`.

used_up
boolean

Whether or not this discount has been used up. If not used up, this discount will create secondary discounts on future checkouts.

checkout

Expandable – The associated checkout ID.

coupon

Expandable – The associated coupon ID.

customer

Expandable – The associated customer ID.

primary_discount

Expandable – The associated discount ID.

promotion

Expandable – The associated promotion ID.

secondary_discounts

Expandable – Property not returned unless expanded.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.