API reference › Rates and billing › Provider portal
Retrieve provider pay cancellation settings
GET /v1/settings/rates-billing/provider-pay-cancellation
- Scope
settings_rates_billing:read finance:read- Roles
- admin, scheduler
Fetches the provider pay cancellation configuration for the organization, including the cancellation window, fee type, fee value and notes.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/rates-billing/provider-pay-cancellation" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Provider pay cancellation retrieved successfully
Provider pay cancellation retrieved successfully
{
"success": true,
"message": "Provider pay cancellation retrieved!",
"data": {
"allowCancellationPay": true,
"cancellationWindow": {
"id": 1,
"label": "Example label"
},
"feeType": "string",
"feeValue": 0,
"cancellationPayNotes": "Added by the scheduler."
}
}Response fields (10)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.allowCancellationPay | boolean | Example |
data.cancellationWindow | object | |
data.cancellationWindow.id | integer | Example |
data.cancellationWindow.label | string | Example |
data.feeType | string | Example |
data.feeValue | integer | Example |
data.cancellationPayNotes | string | 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 |