Create Fee

Creates a service fee that can be charged on bills (optionally auto-applied). Requires the p/manage-fees permission — the standard app role does not include it, so this operation is documented from code and returns 403 FORBIDDEN without that permission.

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

Must be greater than 0. A fixed amount or a percentage depending on rate_type.

string
enum
required
Allowed:
string | null
enum

Auto-apply the fee to every bill (all) or to bills of specific subtypes (bill-subtype).

Allowed:
auto_apply_config
array | null

Required when auto_apply_type is bill-subtype: list of bill subtype keys.

auto_apply_config
taxes
array | null

Tax ids to charge on the fee.

taxes
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Responses

403

Missing the p/manage-fees permission.

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