Subscriber FUP API
Overview
This API provides programmatic access to manage Fair Usage Policies (FUPs) and their rules. It is the same data used by the console UI. For a complete explanation of how FUPs behave — thresholds, cycles, how multiple rules stack, and why the subscriber's timezone matters — see Fair Usage Policies.
A FUP profile is a named container that holds one or more rules. Each rule reduces speed once a data threshold is reached within a daily, weekly, or monthly cycle. A FUP profile is applied to a subscriber profile, and every subscriber on that profile inherits the policy.
The typical workflow is:
Create a FUP profile — POST /v1/fup.
Add one or more rules to it — POST /v1/fup/{fup_id}/rule.
Apply the FUP profile to a subscriber profile using the Subscriber Profiles API.
FUP Profiles
Manage the FUP profile — the named container that rules belong to.
List FUPs
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| l | query | integer | Paginate Limit / Entities per Page. (1-50, -1 for streaming) | |
| name | query | string | Filter by name. (can suffix with wildcard *) | |
| p | query | integer | Paginate Current Page. (default 1) | |
| s | query | string | Search. (returns best matches) | |
| sc | query | string | Sort by Property/Column. (name) | |
| sd | query | string | Sort direction. asc for Ascending or desc for Descending |
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| creation_time | body | string | Creation Time. |
| id | body | string | Unique Entity ID. |
| metadata.page | body | integer | Current Page. (always 1 for infinite) |
| metadata.pages | body | integer | Total Pages. (always 1 for infinite) |
| metadata.per_page | body | integer | Equeal to the entities per page limit or always equal to total records for infinite queries. |
| metadata.records | body | integer | Total entities found. (always max 250 unless infinite is accepted query parameter) |
| name | body | string | Name of Entity. |
Response Example
{
"payload": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"name": "Profile 1",
"creation_time": "2025-01-01T00:00:00.000Z"
}
],
"metadata": {
"records": 1,
"page": 1,
"pages": 1,
"per_page": 10
}
}
Get a single FUP
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| creation_time | body | string | Creation Time. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| name | body | string | Name of Entity. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"name": "Profile 1",
"creation_time": "2025-01-01T00:00:00.000Z"
}
Create a FUP
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| name | body | string | Name of Entity. | X |
Request Example
{
"name": "Profile 2"
}
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| creation_time | body | string | Creation Time. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| name | body | string | Name of Entity. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"domain": "domain.com",
"name": "Profile 2",
"creation_time": "2025-01-01T00:00:00.000Z"
}
Update a FUP
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
| name | body | string | Name of Entity. |
Request Example
{
"name": "Profile 2 Updated"
}
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| creation_time | body | string | Creation Time. |
| domain | body | string | Entity Domain. |
| id | body | string | Unique Entity ID. |
| name | body | string | Name of Entity. |
Response Example
{
"id": "4381239d-6e79-4bcb-97fa-ced50b1f6067",
"domain": "domain.com",
"name": "Profile 2 Updated",
"creation_time": "2025-01-01T00:00:00.000Z"
}
Delete a FUP
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
Response Status Codes
| Code | Meaning |
|---|---|
| 204 | OK - No Content |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
FUP Rules
Each rule belongs to a FUP profile and defines a single throttling condition. See Fair Usage Policies for the meaning of each field:
chain — the traffic the rule measures: download, upload, or combined.
cycle — the counter the rule watches and when it resets: daily, weekly, or monthly.
volume_threshold — data used (in GB) before the rule takes effect.
download_reduction_percent / upload_reduction_percent — how much to cut each direction of speed (0–100).
start_hour / end_hour — the time-of-day window the rule is active. These hours are in UTC.
rule_order — the order the rule is evaluated in.
List FUP Rules
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| chain | body | string | Chain. |
| cycle | body | string | Cycle. |
| download_reduction_percent | body | integer | Download Reduction Percent. |
| end_hour | body | string | End Hour. |
| fup_profile_id | body | string | Fup Profile Id. |
| id | body | string | Unique Entity ID. |
| input_policy_name | body | string | Input Policy Name. |
| output_policy_name | body | string | Output Policy Name. |
| policy_name | body | string | Policy Name. |
| rule_order | body | integer | Rule Order. |
| start_hour | body | string | Start Hour. |
| upload_reduction_percent | body | integer | Upload Reduction Percent. |
| volume_threshold | body | integer | Volume Threshold. |
Response Example
[
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"fup_profile_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 1,
"chain": "download",
"volume_threshold": 5,
"cycle": "daily",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 10,
"upload_reduction_percent": 10,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"fup_profile_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 2,
"chain": "combined",
"volume_threshold": 10,
"cycle": "weekly",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 50,
"upload_reduction_percent": 50,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
},
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"fup_profile_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 3,
"chain": "upload",
"volume_threshold": 50,
"cycle": "monthly",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 75,
"upload_reduction_percent": 75,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
}
]
View a Single FUP Rule
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
| rule_id | url | string | Rule Id. | X |
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| chain | body | string | Chain. |
| cycle | body | string | Cycle. |
| download_reduction_percent | body | integer | Download Reduction Percent. |
| end_hour | body | string | End Hour. |
| fup_profile_id | body | string | Fup Profile Id. |
| id | body | string | Unique Entity ID. |
| input_policy_name | body | string | Input Policy Name. |
| output_policy_name | body | string | Output Policy Name. |
| policy_name | body | string | Policy Name. |
| rule_order | body | integer | Rule Order. |
| start_hour | body | string | Start Hour. |
| upload_reduction_percent | body | integer | Upload Reduction Percent. |
| volume_threshold | body | integer | Volume Threshold. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"fup_profile_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 1,
"chain": "download",
"volume_threshold": 50,
"cycle": "monthly",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 75,
"upload_reduction_percent": 75,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
}
Create a FUP Rule
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
| chain | body | string | Chain. | X |
| cycle | body | string | Cycle. | X |
| download_reduction_percent | body | integer | Download Reduction Percent. | |
| end_hour | body | string | End Hour. | |
| input_policy_name | body | string | Input Policy Name. | |
| output_policy_name | body | string | Output Policy Name. | |
| policy_name | body | string | Policy Name. | |
| rule_order | body | integer | Rule Order. | X |
| start_hour | body | string | Start Hour. | |
| upload_reduction_percent | body | integer | Upload Reduction Percent. | |
| volume_threshold | body | integer | Volume Threshold. | X |
Request Example
{
"rule_order": 1,
"chain": "download",
"volume_threshold": 50,
"cycle": "monthly",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 50,
"upload_reduction_percent": 50,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
}
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| chain | body | string | Chain. |
| cycle | body | string | Cycle. |
| download_reduction_percent | body | integer | Download Reduction Percent. |
| end_hour | body | string | End Hour. |
| fup_profile_id | body | string | Fup Profile Id. |
| id | body | string | Unique Entity ID. |
| input_policy_name | body | string | Input Policy Name. |
| output_policy_name | body | string | Output Policy Name. |
| policy_name | body | string | Policy Name. |
| rule_order | body | integer | Rule Order. |
| start_hour | body | string | Start Hour. |
| upload_reduction_percent | body | integer | Upload Reduction Percent. |
| volume_threshold | body | integer | Volume Threshold. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"fup_profile_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 1,
"chain": "download",
"volume_threshold": 50,
"cycle": "monthly",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 50,
"upload_reduction_percent": 50,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
}
Update a FUP Rule
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
| rule_id | url | string | Rule Id. | X |
| chain | body | string | Chain. | |
| cycle | body | string | Cycle. | |
| download_reduction_percent | body | integer | Download Reduction Percent. | |
| end_hour | body | string | End Hour. | |
| input_policy_name | body | string | Input Policy Name. | |
| output_policy_name | body | string | Output Policy Name. | |
| policy_name | body | string | Policy Name. | |
| rule_order | body | integer | Rule Order. | |
| start_hour | body | string | Start Hour. | |
| upload_reduction_percent | body | integer | Upload Reduction Percent. | |
| volume_threshold | body | integer | Volume Threshold. |
Request Example
{
"rule_order": 1,
"chain": "download",
"volume_threshold": 100,
"cycle": "monthly",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 50,
"upload_reduction_percent": 50,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
}
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| chain | body | string | Chain. |
| cycle | body | string | Cycle. |
| download_reduction_percent | body | integer | Download Reduction Percent. |
| end_hour | body | string | End Hour. |
| fup_profile_id | body | string | Fup Profile Id. |
| id | body | string | Unique Entity ID. |
| input_policy_name | body | string | Input Policy Name. |
| output_policy_name | body | string | Output Policy Name. |
| policy_name | body | string | Policy Name. |
| rule_order | body | integer | Rule Order. |
| start_hour | body | string | Start Hour. |
| upload_reduction_percent | body | integer | Upload Reduction Percent. |
| volume_threshold | body | integer | Volume Threshold. |
Response Example
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"fup_profile_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 1,
"chain": "download",
"volume_threshold": 100,
"cycle": "monthly",
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 50,
"upload_reduction_percent": 50,
"policy_name": "policy_1",
"input_policy_name": "input_policy_1",
"output_policy_name": "output_policy_1"
}
Delete a FUP Rule
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| fup_id | url | string | Fup Id. | X |
| rule_id | url | string | Rule Id. | X |
Response Status Codes
| Code | Meaning |
|---|---|
| 204 | OK - No Content |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Subscriber FUP Usage
View or reset the usage counters a subscriber's FUP rules are measured against. Each daily, weekly and monthly cycle reports its current period and the combined, download and upload usage in kilobytes. Periods follow the subscriber's local time.
Resetting clears all three cycles to zero, for example to test a policy again.
Get Subscriber FUP Usage
subscriber
Accepted Roles (RBAC)
AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSubscriber TelemetrySubscriber ViewSupportRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| X-Tenant-ID | header | string | Request Tenant Context. (requires X-Domain of the tenant) | |
| X-Timezone | header | string | Timezone for response datetime property values. (default UTC) | |
| subscriber_id | url | string | Unique subscriber ID. | X |
Response Status Codes
| Code | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |
Response Properties
| Name | In | Type | Description |
|---|---|---|---|
| daily | body | object | Usage for the current day. |
| daily.combined_kb | body | integer | Download plus upload usage in kilobytes. |
| daily.download_kb | body | integer | Download usage in kilobytes. |
| daily.period | body | string | Current day in YYYY-MM-DD format. |
| daily.upload_kb | body | integer | Upload usage in kilobytes. |
| fup | body | object | FUP profile assigned to the subscriber, or null. |
| fup.id | body | string | Unique FUP profile ID. |
| fup.name | body | string | FUP profile name. |
| monthly | body | object | Usage for the current month. |
| monthly.combined_kb | body | integer | Download plus upload usage in kilobytes. |
| monthly.download_kb | body | integer | Download usage in kilobytes. |
| monthly.period | body | string | Current month in YYYY-MM format. |
| monthly.upload_kb | body | integer | Upload usage in kilobytes. |
| policy | body | object | Policy before and after FUP. |
| policy.base | body | object | Policy before FUP, including active boosts. |
| policy.base.download | body | string | Download Mbit/s before FUP, decimal with 3 places (e.g. "100.000"). |
| policy.base.input_policy_name | body | string | Input policy name before FUP. |
| policy.base.output_policy_name | body | string | Output policy name before FUP. |
| policy.base.policy_name | body | string | Policy name before FUP. |
| policy.base.upload | body | string | Upload Mbit/s before FUP, decimal with 3 places (e.g. "50.000"). |
| policy.effective | body | object | Policy after all triggered FUP rules are applied. |
| policy.effective.download | body | string | Download Mbit/s after FUP, decimal with 3 places. |
| policy.effective.input_policy_name | body | string | Input policy name after FUP. |
| policy.effective.output_policy_name | body | string | Output policy name after FUP. |
| policy.effective.policy_name | body | string | Policy name after FUP. |
| policy.effective.upload | body | string | Upload Mbit/s after FUP, decimal with 3 places. |
| subscriber_id | body | string | Unique subscriber ID. |
| triggered | body | boolean | True when one or more FUP rules are triggered. |
| triggered_rules | body | array | Triggered rules in the order they were applied. Reductions compound, each applies to the result of the previous rule. |
| triggered_rules.applied_order | body | integer | Position the rule was applied in, starting at 1. |
| triggered_rules.chain | body | string | download, upload or combined. |
| triggered_rules.cycle | body | string | daily, weekly or monthly. |
| triggered_rules.download_after | body | string | Download Mbit/s after this rule was applied, decimal with 3 places. |
| triggered_rules.download_reduction_percent | body | integer | Download speed reduction %. |
| triggered_rules.end_hour | body | string | Effective end time (24h clock time UTC, HH:MM). |
| triggered_rules.id | body | string | Unique FUP rule ID. |
| triggered_rules.input_policy_name | body | string | Input policy name set by this rule. |
| triggered_rules.output_policy_name | body | string | Output policy name set by this rule. |
| triggered_rules.policy_name | body | string | Policy name set by this rule. |
| triggered_rules.rule_order | body | integer | Configured rule order. |
| triggered_rules.start_hour | body | string | Effective start time (24h clock time UTC, HH:MM). |
| triggered_rules.upload_after | body | string | Upload Mbit/s after this rule was applied, decimal with 3 places. |
| triggered_rules.upload_reduction_percent | body | integer | Upload speed reduction %. |
| triggered_rules.usage_kb | body | integer | Usage in kilobytes for the rule cycle and chain. |
| triggered_rules.volume_threshold | body | integer | Threshold in GB. |
| weekly | body | object | Usage for the current ISO week. |
| weekly.combined_kb | body | integer | Download plus upload usage in kilobytes. |
| weekly.download_kb | body | integer | Download usage in kilobytes. |
| weekly.period | body | string | Current ISO week in YYYY-Www format (e.g., 2025-W01). |
| weekly.upload_kb | body | integer | Upload usage in kilobytes. |
Response Example
{
"subscriber_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"fup": {
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"name": "Home 100GB FUP"
},
"daily": {
"period": "2026-10-27",
"combined_kb": 4200000,
"download_kb": 3900000,
"upload_kb": 300000
},
"weekly": {
"period": "2026-W44",
"combined_kb": 38500000,
"download_kb": 35100000,
"upload_kb": 3400000
},
"monthly": {
"period": "2026-10",
"combined_kb": 152340000,
"download_kb": 140020000,
"upload_kb": 12320000
},
"policy": {
"base": {
"download": "100.000",
"upload": "50.000",
"policy_name": "HOME-100M",
"input_policy_name": null,
"output_policy_name": null
},
"effective": {
"download": "25.000",
"upload": "25.000",
"policy_name": "FUP-PEAK",
"input_policy_name": null,
"output_policy_name": null
}
},
"triggered": true,
"triggered_rules": [
{
"applied_order": 1,
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 1,
"cycle": "monthly",
"chain": "combined",
"volume_threshold": 100,
"usage_kb": 152340000,
"start_hour": "00:00",
"end_hour": "23:59",
"download_reduction_percent": 50,
"upload_reduction_percent": 0,
"download_after": "50.000",
"upload_after": "50.000",
"policy_name": "FUP-100GB",
"input_policy_name": null,
"output_policy_name": null
},
{
"applied_order": 2,
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"rule_order": 2,
"cycle": "monthly",
"chain": "download",
"volume_threshold": 140,
"usage_kb": 140020000,
"start_hour": "11:00",
"end_hour": "23:59",
"download_reduction_percent": 50,
"upload_reduction_percent": 50,
"download_after": "25.000",
"upload_after": "25.000",
"policy_name": "FUP-PEAK",
"input_policy_name": null,
"output_policy_name": null
}
]
}
Reset Subscriber FUP Usage
subscriber
Accepted Roles (RBAC)
AdministratorNetwork OperationsSubscriber AccountsSubscriber AdministratorRequest Parameters
| Name | In | Type | Description | MUST include |
|---|---|---|---|---|
| X-Auth-Token | header | string | Valid Authentication Token. Please see developers documentation/identity. | X |
| X-Domain | header | string | Optional domain context for the request. (default: the token domain) | |
| X-Tenant-ID | header | string | Request Tenant Context. (requires X-Domain of the tenant) | |
| subscriber_id | url | string | Unique subscriber ID. | X |
Response Status Codes
| Code | Meaning |
|---|---|
| 204 | OK - No Content |
| 400 | Bad Request |
| 401 | Unauthorized / Require Authentication |
| 403 | Forbidden / Access Denied |
| 404 | Not Found |
| 409 | Conflict |
| 429 | Too Many Requests / Your Rate Limited |
| 500, 501, 502, 503, 504 | Service Unavailable |