CustomFeeDefinition
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents an arbitrary custom fee or charge defined by a reseller or merchant. This structure is shared by both platform-level billing and merchant-created invoices.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
label
required |
string | Display label for the fee (shown in UI and reports).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
code
required |
string | Internal code for programmatic or accounting reference.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
chargeType
required |
ChargeType ChargeType | Classification of the charge (e.g. platform fee, merchant product, tax, discount).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
frequency
required |
FeeFrequency FeeFrequency | Indicates billing frequency (one-time, recurring, per-transaction, etc.).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
period
required |
BillingPeriod BillingPeriod | Defines the billing period interval (e.g. every 1 month, every 3 months).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
Fields of BillingPeriod:
This body has no documented fields. | ||||||||||||||||||||||||||
category
required |
string | Category for grouping related fees (e.g. Add-Ons, Fraud Tools).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
strategy
required |
BillingPricingStrategy BillingPricingStrategy | Pricing model for this fee (fixed, percentage, or tiered).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
percentageRate
required |
number (double) | The percentage rate (used when Strategy = Percentage).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
tiers
required |
array of TierDefinition array of TierDefinition | Tier definitions (used when Strategy = Tiered).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
Fields of each TierDefinition: This body has no documented fields. | ||||||||||||||||||||||||||
amounts
required |
FeePair FeePair | The buy/sell values for this fee (used when Strategy = Fixed).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
Fields of FeePair:
This body has no documented fields. | ||||||||||||||||||||||||||
currency
required |
string | Currency for this fee (overrides plan-level currency if set).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
taxCode
required |
string | Optional tax code for integration with tax engines or accounting systems.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
showOnInvoice
required |
boolean | Determines whether this item should be visible on customer invoices.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
isActive
required |
boolean | Indicates if this fee is currently active.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
metadata
required |
object | Arbitrary metadata for extensibility (e.g., tax region, GL mapping, reseller visibility).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||
This model has no documented fields.