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

NameTypeDescription
tab requiredstring

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: sidebar, service-type-rates, provider-pay, expenses-settings, cancellation-settings, invoice-proforma-settings, payables-and-payment-settings. Example sidebar.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

dataobject
data.defaultCurrencystring

Example USD.

data.providerRatesarray of object
data.providerRates[].idinteger

Example 1.

data.providerRates[].rateTypeinteger

Example 1.

data.providerRates[].serviceTypeinteger

Example 1.

data.providerRates[].serviceProviderTypeinteger

Example 1.

data.providerRates[].providerRolestring

Example agency.

data.providerRates[].certificationinteger

Example 1.

data.providerRates[].siteTypestring

Example onsite.

data.providerRates[].specializationinteger

Example 1.

data.providerRates[].unitstring

Example per_hour.

data.providerRates[].ratestring

Example 50.00.

data.providerRates[].minimumDurationinteger

Example 6.

data.providerRates[].assignmentboolean

Example true.

data.providerRates[].shiftboolean

Example true.

401 Not signed in

Unauthorized - authentication required

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_rates_billing:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..