Get list of subscriptions

get

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

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, activated, expired, cancelled, on_hold or reactivated

Allowed:

handle

string

Subscription exact handle

handle_prefix

string

Subscription handle prefix

handle_contains

string

Subscription handle contains

customer

string

Customer owning subscription

plan

string

Plan owning subscription

state

array of strings

enum

Subscription state, multiple can be defined. States: active, expired, on_hold, pending, cancelled or active_non_cancelled. The cancelled state matches subscriptions that are active but have been marked for cancellation (still running until period end). The active_non_cancelled state matches subscriptions that are active and have not been marked for cancellation.

amount

string

Custom amount in minor unit interval. See documentation of intervals.

quantity

string

Quantity. See documentation of intervals.

activated

string

Activated date interval

cancelled_date

string

Cancelled date interval

reactivated

string

Reactivated date interval

created

string

Created date interval

renewing

string

Renewing flag. Values: true or false

plan_version

int32

Plan version

amount_incl_vat

string

Amount incl vat test flag. Values: true or false

start_date

string

Start date interval

end_date

string

End date interval

grace_duration

string

Grace duration in seconds. See documentation of intervals.

current_period_start

string

Current period start date interval

next_period_start

string

Next period start date interval

first_period_start

string

First period start date interval

last_period_start

string

Last period start date interval

trial_start

string

Trial period start date interval

trial_end

string

Trial period end date interval

in_trial

string

In trial flag. Values: true or false

has_started

string

Has started flag. Values: true or false

renewal_count

string

Renewal Count. See documentation of intervals.

expired_date

string

Expired period date interval

expire_reason

array of strings

enum

On hold reason, multiple can be defined. Types: dunning, cancelled,ondemand, and fixed

on_hold_date

string

On hold period date interval

on_hold_reason

array of strings

enum

On hold reason, multiple can be defined. Types: ondemand, and dunning

payment_method_added

string

Payment method added flag. Values: true or false

has_active_payment_method

string

Whether there is at least one active payment method. Values: true or false

reminder_email_sent

string

Reminder email sent period date interval

failed_invoices

string

Failed invoices. See documentation of intervals.

failed_amount

string

Failed amount. See documentation of intervals.

cancelled_invoices

string

Cancelled invoices. See documentation of intervals.

cancelled_amount

string

Cancelled amount. See documentation of intervals.

pending_invoices

string

Pending invoices. See documentation of intervals.

pending_amount

string

Pending amount invoices. See documentation of intervals.

dunning_invoices

string

Dunning invoices. See documentation of intervals.

dunning_amount

string

Dunning amount. See documentation of intervals.

settled_invoices

string

Settled invoices. See documentation of intervals.

settled_amount

string

Settled amount. See documentation of intervals.

refunded_amount

string

Refunded amount. See documentation of intervals.

pending_additional_costs

string

Pending additional costs. See documentation of intervals.

pending_additional_cost_amount

string

Pending additional cost amount. See documentation of intervals.

transferred_additional_costs

string

Transferred additional costs. See documentation of intervals.

transferred_additional_cost_amount

string

Transferred additional cost amount. See documentation of intervals.

pending_credits

string

Pending credits. See documentation of intervals.

pending_credit_amount

string

Pending credit amount. See documentation of intervals.

transferred_credits

string

Transferred credits. See documentation of intervals.

transferred_credit_amount

string

Transferred credit amount. See documentation of intervals.

subscription_add_on_handle

string

Subscription add-on handle

add_on_handle

string

Add-on handle

subscription_discount_handle

string

Subscription discount handle

discount_handle

string

Discount handle

coupon_handle

string

Coupon handle

payment_method

string

Payment method id

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