Tariffsv1Velocity Usage
Get customer velocity usage
Returns in-memory velocity usage, limits, remaining quota, and bucket TTL for the customer's transfer and FX tariffs. `reference_id` in the response matches the package-year bucket (`{customer_id}:{package_year}` from `customers.metadata.package_year`). Requires read access on the customer record.
GET
/v1/tariffs/customers/{customer_id}/velocity-usageAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
customer_id*string
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/tariffs/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/velocity-usage"{
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"package_year": 0,
"reference_id": "string",
"transfer": [
{
"velocity_rule_id": "5a6668cb-74b1-441a-9722-f0b3d064324b",
"tariff_id": "d82b8db6-f412-4b9c-8c5e-6a0221035c86",
"tariff_kind": "string",
"type": "transaction_count",
"interval": "string",
"limit": 0,
"used": 0,
"remaining": 0,
"exceeded": true,
"package_year": 0,
"reference_id": "string",
"ttl_seconds": 0,
"bucket_resets_at": "2019-08-24T14:15:22Z",
"asset": "string",
"media": "string",
"transaction_type": "string"
}
],
"fx": [
{
"velocity_rule_id": "5a6668cb-74b1-441a-9722-f0b3d064324b",
"tariff_id": "d82b8db6-f412-4b9c-8c5e-6a0221035c86",
"tariff_kind": "string",
"type": "transaction_count",
"interval": "string",
"limit": 0,
"used": 0,
"remaining": 0,
"exceeded": true,
"package_year": 0,
"reference_id": "string",
"ttl_seconds": 0,
"bucket_resets_at": "2019-08-24T14:15:22Z",
"asset": "string",
"media": "string",
"transaction_type": "string"
}
]
}{
"code": "tariffs_m.invalid_tariff_data",
"message": "Invalid tariff data provided"
}Empty
{
"code": "tariffs_m.tariff_not_found",
"message": "Tariff not found"
}