Billing
Preview the fee for a given amount
Returns the single all-in Mudbase fee, its effective rate, and what the org would net for the given amount, without creating a payment. Pass country/method/international to price a specific rail; omitting them uses a generic local-rail estimate. Never returns the underlying rail's own cost or any internal margin split.
GET
/api/orgs/{orgId}/payment-processing/fee-breakdownSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, BillingApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const billing = new BillingApi(configuration);import { Configuration, BillingApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const billing = new BillingApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await billing.getFeeBreakdown("org_mmn2oyWXy5");const { data: result } = await billing.getFeeBreakdown("org_mmn2oyWXy5");Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string | Yes | - |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | - |
currency | string | No | - |
country | string | No | ISO-3166 alpha-2 payout country code, one of the codes from GET /payment-processing/countries. |
method | string | No | - |
international | boolean | No | Set true for a cross-border/international card, Apple Pay, or Google Pay. |
Responses
200Fee breakdown
json
{
"success": true,
"data": {
"amount": 637.81,
"currency": "SSP",
"orgReceives": 780.14,
"fee": 593.89,
"feeRate": 31.82
}
}{
"success": true,
"data": {
"amount": 637.81,
"currency": "SSP",
"orgReceives": 780.14,
"fee": 593.89,
"feeRate": 31.82
}
}400-
401-
Errors
| Code | Meaning |
|---|---|
400 | - |
401 | - |