Skip to main content
GET
List promo codes
This page documents the Legacy API. For new integrations, use List Promo Codes in the Current API.
Required permissions:
  • promo_code:basic:read
  • access_pass:basic:read

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

promo_code:basic:read
access_pass:basic:read

Sorgu Parametreleri

after
string

Returns the elements in the list that come after the specified cursor.

before
string

Returns the elements in the list that come before the specified cursor.

first
integer

Returns the first n elements from the list.

Örnek:

42

last
integer

Returns the last n elements from the list.

Örnek:

42

product_ids
string[]

Filter to only promo codes scoped to these product identifiers.

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

plan_ids
string[]

Filter to only promo codes scoped to these plan identifiers.

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

status
enum<string>

Filter to only promo codes matching this status.

Mevcut seçenekler:
active,
inactive,
archived
created_before
string<date-time>

Only return promo codes created before this timestamp.

Örnek:

"2023-12-01T05:00:00.401Z"

created_after
string<date-time>

Only return promo codes created after this timestamp.

Örnek:

"2023-12-01T05:00:00.401Z"

account_id
string
gerekli

The unique identifier of the company to list promo codes for.

Örnek:

"biz_xxxxxxxxxxxxxx"

Yanıt

A successful response

The connection type for PromoCode.

data
object[]
gerekli

A list of nodes.

page_info
object
gerekli

Information to aid in pagination.