Billwerk+ is now Frisbii
API Reference
Frisbii WebsiteKnowledge BaseTry for freeBook a demo

Update plan

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

minor update of a plan, like name or description

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Subscription handle

Body Params
string
required
length ≥ 1

Name of the plan

string

Description of the plan

float

Optional vat for this plan. Account default is used if none given.

string

Dunning plan by handle to use for the subscription plan. Default dunning plan will be used if none given.

string

Optional tax policy handle for this plan. If vat and tax policy is given, vat will be ignored.

int32
≥ 1

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

int32
≥ 1

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

string
enum

How to handle a potential initial partial billing period for fixed day scheduling. The options are to bill for a full period, bill prorated for the partial period, bill a zero amoumt, or not to consider the period before first fixed day a billing period. The default is to bill prorated. Options: bill_full, bill_prorated, bill_zero_amount, no_bill.

Allowed:
boolean

Whether to add a zero amount order line to subscription invoices if plan amount is zero or the subscription overrides to zero amount. The default is to not include the line. If no other order lines are present the plan order line will be added.

int32
≥ 0

Optional one-time setup fee billed with the first invoice or as a separate invoice depending on the setting setup_fee_handling.

string

Optional invoice order text for the setup fee that

string

How the billing of the setup fee should be done. The options are: first - include setup fee as order line on the first scheduled invoice. separate - create a separate invoice for the setup fee, is appropriate if first invoice is not in conjunction with creation. separate_conditional - create a separate invoice for setup fee if the first invoice is not created in conjunction with the creation. Default is first.

float

Optional VAT for setup fee. Only returns the explicitly configured VAT rate, not the resolved rate from tax policy. Use effective_setup_fee_vat to see what will be used.

string

Optional tax policy handle for setup fee. If both setup_fee_vat and setup_fee_tax_policy are configured, tax policy takes precedence.

boolean

Whether setup fee amount is including VAT. Only returns the explicitly configured value. Use effective_setup_fee_amount_incl_vat to see what will be used.

boolean

For fixed day scheduling and prorated partial handling calculate prorated amount using whole days counting start day as a full day, or use by the minute proration calculation from start date time to the next period start. Default is true (whole days).

boolean

When using trial for fixed day scheduling use this setting to control if trial expires at midnight or the trial period is down to the minute. Default is true (trial until start of day). Trial in days can only be true if partial_proration_days is also set to true.

int32
≥ 0

When using prorated partial handling the prorated amount for plan and add-ons might result in very small amounts. A minimum prorated amount for plan and add-ons can be defined. If the prorated amount is below this minimum the amount will be changed to zero.

boolean

Indicates that Account Funding Transaction (AFT) is requested.

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago