Get list of coupons

get

https://api.frisbii.com/v1/list/coupon

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from

string

Time range from (inclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Default from if no interval is given depends on the query. If the query limits on relation e.g. customer and/or subscription, the default from will be epoch 1970-01-01, otherwise one month before to

string

Time range to (exclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Defaults to now.

interval

string

Limit from to and interval back in time. E.g. one week. Will take precedence over from. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations

size

int32

10 to 100

Defaults to 20

Page size between 10 and 100 (default 20)

next_page_token

string

Next page token from previous response to get next page

range

string

enum

Defaults to created

Time and date attribute to time limit. Can be the created or expired

Allowed:

handle

string

Coupon exact handle

handle_prefix

string

Coupon handle prefix

state

array of strings

enum

Coupon state, multiple can be defined. States: active, deleted, expired or generating

type

string

enum

Type of coupon. Accepted values: single or set

Allowed:

expire_reason

array of strings

enum

The expire reason if expired, multiple can be defined. Possible values: early, valid_until or max

discount_handle

string

Handle of discount to use for coupon

discount_currency

array of strings

Currency for discount on coupon in ISO 4217 three letter alpha code. Multiple can be defined.

discount_currency

discount_percentage

string

Percentage discount applied to each applicable discount.

eligible_currency

string

Eligible coupon by currency or percentage in ISO 4217 three letter alpha code

code

string

The coupon code. Maximum 128 characters.

name

string

Internal name for the coupon.

all_plans

string

Whether all plans are eligible for this coupon. Values: true or false

max_redemptions

string

Optional maximum number of times this coupon can be redeemed.

redemptions

string

Number of times the coupon has been redeemed.

valid_until

string

Valid-until period date interval

Responses

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii