The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 23:35 UTC.
API reference
/
Models
BillingPriceOverridesA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
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 fees
required object
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.
feesJson
required string
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.
customFees
required array of CustomFeeDefinition
array of CustomFeeDefinition 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 CustomFeeDefinition:
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.
PlatformFeeMerchantFeeTaxDiscountAdjustment
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.
OneTimeRecurringPerTransactionAnnualCustom
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.
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.
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.
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 body has no documented fields.
This model has no documented fields.
Next steps