Get list of discounts

get

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

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 for time limit. Can be created or deleted

Allowed:

handle

string

Discount exact handle

handle_prefix

string

Discount handle prefix

state

string

enum

State of discount. States: active or deleted

Allowed:

apply_to

array of strings

enum

Which order lines the discount is applicable to: all, setup_fee, plan, additional_cost, add_on, ondemand and metered_billing_product. Multiple can be defined.

name

string

Name of discount. Used as order line text.

description

string

Optional description of discount

amount

string

Fixed amount discount deducted from order line amounts including VAT.

percentage

string

Percentage discount applied to each applicable order line.

fixed_count

string

Apply discount to a fixed number of invoices

currency

array of strings

Discount currency in ISO 4217 three letter alpha code. Multiple can be defined.

currency

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