API reference › Rates and billing › Rate and billing settings
Retrieve specific tab details of rates and billing settings
GET /v1/settings/rates-billing/{tab}
- Scope
settings_rates_billing:read finance:read- Roles
- admin, scheduler
Fetches the details for a specific tab within the rates and billing settings, based on the provided tab identifier. The service-type-rates, provider-pay and expenses-settings tabs are Finances data: without Finance Read they answer 200 with an empty page (data [], meta.total 0) and the reason in message. The other tabs follow Rates & Billing alone.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
tab required | string | Identifier for the specific tab to fetch (e.g., 'sidebar', 'service-type-rates', 'expenses-settings', 'cancellation-settings', 'invoice-proforma-settings', 'payables-and-payment-settings') One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/rates-billing/{tab}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Rates and billing details retrieved successfully
Rates and billing details retrieved successfully
{
"success": true,
"data": {
"defaultCurrency": "USD",
"providerRates": [
{
"id": 1,
"rateType": 1,
"serviceType": 1,
"serviceProviderType": 1,
"providerRole": "agency",
"certification": 1,
"siteType": "onsite",
"specialization": 1,
"unit": "per_hour",
"rate": "50.00",
"minimumDuration": 6,
"assignment": true,
"shift": true
}
]
}
}Response fields (17)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | object | |
data.defaultCurrency | string | Example |
data.providerRates | array of object | |
data.providerRates[].id | integer | Example |
data.providerRates[].rateType | integer | Example |
data.providerRates[].serviceType | integer | Example |
data.providerRates[].serviceProviderType | integer | Example |
data.providerRates[].providerRole | string | Example |
data.providerRates[].certification | integer | Example |
data.providerRates[].siteType | string | Example |
data.providerRates[].specialization | integer | Example |
data.providerRates[].unit | string | Example |
data.providerRates[].rate | string | Example |
data.providerRates[].minimumDuration | integer | Example |
data.providerRates[].assignment | boolean | Example |
data.providerRates[].shift | boolean | Example |
401 Not signed in
Unauthorized - authentication required
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_rates_billing:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error
{
"success": false,
"message": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |