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

Create coupon

post
https://api.frisbii.com/v1/coupon
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Create a coupon. The coupon code needs to be unique for the currently active coupons.

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.

Error code HTTP codeDescription
11400Duplicate handle
88400Coupon code already exists
83404Discount not found
10404Plan provided in eligible plans not found
Body Params
string
required
length ≥ 1

Internal name for the coupon.

string
required
length ≥ 1

Per account unique handle for the coupon

string
required
length ≥ 1

The coupon code. Maximum 100 characters.

string
required
length ≥ 1

Discount to use for coupon

metadata
object

Custom metadata.

boolean

Whether all plans are eligible for this coupon. Defaults to false.

eligible_plans
array of strings

If not all_plans are set to true, then the set of eligible plan handles must be defined.

eligible_plans
int32
≥ 1

Optional maximum number of times this coupon can be redeemed.

string

Optional date and time until which the coupon is redeemable. Date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss.

string
enum

This field determines the coupon redemption strategy for applying coupons. It accepts the following values: once_per_customer, once_per_plan, once_per_subscription. If no 'redemption strategy' value is provided, the default strategy of 'once_per_customer' will be applied.

Allowed:
Responses

Updated about 1 month 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 about 1 month ago