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

Create action

post
https://rule-engine-api.frisbii.com/v1/action

Create a new scheduled action in the Rule Engine

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Action type

schedule
object
required

Scheduling settings for the action

string
required

Optional per subscription unique handle for the subscription add-on. If not defined the handle will default to the add-on handle, this means that by default an add-on can only be attached once to each subscription. The handle can be used to link the subscription add-on to an entity like computer serial number or vehicle license plate.

int32
≥ 1

Optional quantity of the of the add-on for this subscription. Defaults to 1. May only be provided for add-on with type quantity.

int32
≥ 0

Optional custom fixed per quantity add-on price. If provided the add-on price billed for each billing period will be overridden by this price. Implicitly defines fixed_amount as true. Cannot be provided with fixed_amount false.

string

Optional description overriding the add-on description. If not defined the add-on description will be used.

string
enum

Optionally defines when the change will be applied to the subscription after the action is executed. By default, the change will be applied at the next subscription renewal. If set to immediate, the change will be applied immediately after the action is executed. For immediate changes, ensure that you review any potential impacts and choose the billing method if needed. Adding add-ons immediately will result in an charge for the customer in this billing period.

Allowed:
string
required
length ≥ 1

Subscription handle where the addon will be added.

string
required
length ≥ 1

Addon handle to be added to the subscription.

boolean

Whether the price of the subscription add-on should be fixed to the current price of add-on, or the price should follow the add-on price. Defaults to true. If set to false the price of the add-on will be determined by the add-on price at the time of subscription billing.

boolean

Whether the optional amount is including VAT. Defaults to true.

string
enum

Optional billing method for the add-on. If not defined, the default billing method will be used. The default billing method is prorated

Allowed:
Responses

Updated 6 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 6 months ago