Skip to main content
GET
List Discounts

Authorizations

Authorization
string
header
required

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

Query Parameters

coupon_ids[]
string[]

Only return objects with the given coupon IDs.

customer_ids[]
string[]

Only return objects that belong to the given customers.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

page
integer

The page of items you want returned.

primary
boolean

Only return the primary discounts, the first one when the coupon is recurring.

primary_discount_ids[]
string[]

Only return objects that belong to the given primary discount.

promotion_ids[]
string[]

Only return objects with the given promotion IDs.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.