Skip to content
Tallyraydocs

Coupons and promo codes, active and paused unless status says, by code

GET
/v1/buyer/coupons
curl --request GET \
  --url 'https://example.com/v1/buyer/coupons?sort=code' \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

status
string
campaign_id
string
q
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
campaign
required
object
id
required
integer format: int64
name
string
code
required
string
created_at
required
string format: date-time
ends_at
required
string | null format: date-time
id
required
integer format: int64
match
required
string | null
Allowed values: exact prefix
note
required
string
offer
required
Any of:
object
id
required
integer format: int64
name
string
precedence
required
string | null
Allowed values: click code
sequence
required
integer format: int64
status
required
string | null
Allowed values: active paused archived
updated_at
required
string format: date-time
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "match": "exact",
      "precedence": "click",
      "status": "active"
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}