Skip to main content
GET
List promo codes (discounts)

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer

Page number to return. Defaults to 1.

per_page
integer

Number of discounts per page. Defaults to 10.

search_query
string

Filter by discount code (partial match, case-insensitive). Separate several words with spaces to require all of them; * matches any characters.

sorted_by
string

Sort order: created_at, code, active, price_discount_type, or automatic, followed by _asc or _desc, for example created_at_desc. Omitted or unrecognized values sort by id, oldest first.

active
boolean

Pass true to return only active discounts, or false to return only inactive ones. Omit to return both.

source
enum<string>

Filter by discount source. Omit to include merchant and droplet promo codes. Subscription Pro discounts are listed only with source=subscription_pro.

Available options:
promo,
droplet,
subscription_pro

Response

Success

discounts
object[]
meta
object