Skip to content
Tallyraydocs

A coupon

GET
/v1/buyer/coupons/{id}
curl --request GET \
  --url https://example.com/v1/buyer/coupons/example \
  --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”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
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

Example 

{
  "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"
  }
}