Fees
Create a fee
Creates a fee.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
Fee payload
name*string
Name of the fee.
code*string
Unique code for the fee.
plan_id*string
Plan ID or code associated with the fee.
description?string|null
Description of the fee.
invoice_name?string|null
Name that appears on invoices for this fee.
billing_cycles?integer|null
Number of billing cycles for this fee.
Range
1 <= valuebill_timing?string
When to bill for this fee.
Value in
"advance" | "arrears"free_units?integer|null
Number of free units included.
Range
0 <= valuemeter_id?string|null
Meter ID for usage-based billing.
meter_profile_id?string|null
Meter profile ID to use for this fee.
interval*
Billing interval for the fee.
price*
Price configuration for the fee.
entitlements?
Feature entitlements associated with this fee.
Response Body
application/json
curl -X POST "https://api.sandbox.billingrails.com/v1/biller/fees" \ -H "Content-Type: application/json" \ -d '{ "name": "Setup fee", "code": "setup_fee", "plan_id": "plan_IhMUl3rrZ3", "bill_timing": "advance", "invoice_name": "Installation fee", "interval": null, "price": { "model": "flat", "currency": "USD", "amount": 4500 } }'{
"fee": {
"object": "fee",
"id": "fee_IhMUl3rrZ3",
"name": "Setup fee",
"code": "setup_fee",
"invoice_name": "Installation fee",
"plan_id": "plan_IhMUl3rrZ3",
"interval": null,
"created_at": "2025-02-14T17:33:40.843Z",
"price": {
"model": "flat",
"currency": "USD",
"amount": 1000
}
},
"meta": {
"request_id": "req_IhMUl3rrZ3"
}
}