Skip to main content
GET
/
v1
/
discounts
/
{id}
Retrieve Discount
curl --request GET \
  --url https://{defaultHost}/v1/discounts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "6f2daa7b-c180-4aff-93dc-ccd404953f2b",
  "object": "discount",
  "discount_amount": -500,
  "primary": true,
  "redeemable_status": "redeemable",
  "redeemed_at": 1771429802,
  "used_up": false,
  "checkout": "2923364d-70d0-4848-a6a2-124afd1b6d78",
  "coupon": "fc4381a7-48b8-4b6c-9af8-c2dc3b3ec8bd",
  "customer": "adeb019a-c301-40cb-96af-b876af9aa708",
  "primary_discount": null,
  "promotion": null,
  "created_at": 1771429862,
  "updated_at": 1771429862
}

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.