Get list of plans

get

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

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. Accepted value created

Allowed:

handle

string

Plan exact handle

handle_prefix

string

Plan handle prefix

handles

array of strings

Plan handles

handles

state

array of strings

enum

State of the subscription plan, one of the following: active, superseded or deleted. Multiple can be defined.

schedule_type

array of strings

enum

Scheduling type, one of the following: manual, daily, weekly_fixedday, month_startdate, month_fixedday, month_lastday. Multiple can be defined.

partial_period_handling

array of strings

enum

The way to bill initial (not full) period. Options: bill_full, bill_prorated, bill_zero_amount, no_bill. Multiple can be defined.

setup_fee_handling

array of strings

enum

How the billing of the setup fee should be done. Accepted values: first, separate, separate_conditional. Multiple can be defined.

fixed_life_time_unit

array of strings

enum

Time unit use for fixed life time. Accepted units: days or months

trial_interval_unit

array of strings

enum

Time unit for free trial period. Accepted units: days or months

dunning_plan_handle

string

Dunning plan handle

name

string

Name of plan. Used as order line text.

description

string

Optional description of plan

setup_fee_text

string

Optional invoice order text for the setup fee

amount

string

Fixed amount plan deducted from order line amounts including VAT.

quantity

string

Optional default quantity of the subscription plan product for new subscriptions. Default is 1.

fixed_count

string

Fixed number of renewals for subscriptions using this plan. Equals the number of scheduled invoices.

fixed_life_time_length

string

The number of days/months for which the subscription is live.

trial_interval_length

string

The number of days/months for how long the free trial period lasts

interval_length

string

The length of subscription intervals. E.g. every second month or every 14 days.

schedule_fixed_day

string

The number of day for weekly_fixedday and month_fixedday schedule types. For months the allowed values are 1-28 for weeks 1-7

renewal_reminder_email_days

string

Number of days before next billing to send a reminder email.

trial_reminder_email_days

string

Number of days before end of trial to send a reminder email.

base_month

string

Base month for fixed month schedule type

notice_periods

string

Number of notice periods before a cancellation.

minimum_prorated_amount

string

Minimum amount for prorated invoice. If the amount is less, 0 is charged

fixation_periods

string

Number of paid periods before expiring after a cancellation.

setup_fee

string

Optional one-time setup fee billed with the first invoice.

amount_incl_vat

string

Whether the amount is including VAT. Values: true or false

notice_periods_after_current

string

Is cancelled flag. Values: true or false

fixation_periods_full

string

If fixation periods are defined, and the subscription can have a partial prorated first period,this parameter controls if the the last period should be full, or partial. Values: true or false

include_zero_amount

string

Whether to add a zero amount order line to subscription invoices. Values: true or false

partial_proration_days

string

If proration should be day based (instead of minute). Values: true or false

fixed_trial_days

string

Controls if trial expires at midnight or it's down to the minute. Values: true or false

currency

array of strings

Subscription plan 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