List contract surcharges
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/contracts/{contract_id}/surcharges', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"contract_id": "<string>",
"slug": "fuel",
"display_name": "Fuel surcharge",
"billing_type": "PERCENTAGE",
"value": "15.00",
"currency": "EUR",
"is_waived": true,
"origin_country": "<string>",
"destination_country": "<string>",
"service_type": "<string>",
"calculation_base": [
"<string>"
]
}
],
"pagination": {
"cursor": "<string>",
"has_more": true
}
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}{
"statusCode": 404,
"statusReasonCode": "CONTRACT_NOT_FOUND",
"error": "Contract not found"
}Contracts
List contract surcharges
Returns a cursor-paginated list of surcharges extracted from a contract (fuel, residential delivery, peak-season, etc.).
GET
/
v1
/
contracts
/
{contract_id}
/
surcharges
List contract surcharges
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/contracts/{contract_id}/surcharges', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"contract_id": "<string>",
"slug": "fuel",
"display_name": "Fuel surcharge",
"billing_type": "PERCENTAGE",
"value": "15.00",
"currency": "EUR",
"is_waived": true,
"origin_country": "<string>",
"destination_country": "<string>",
"service_type": "<string>",
"calculation_base": [
"<string>"
]
}
],
"pagination": {
"cursor": "<string>",
"has_more": true
}
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}{
"statusCode": 404,
"statusReasonCode": "CONTRACT_NOT_FOUND",
"error": "Contract not found"
}Contracts needs to be activated on your account before you can use it. Reach out to your Opereit account manager to get it turned on.
Authorizations
HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).
Path Parameters
ID of the contract.
Query Parameters
Number of items to return per request.
Required range:
1 <= x <= 100Opaque cursor from a previous response. Omit on the first request.
Free-text search against the surcharge display name.
Filter by how the surcharge is billed.
Available options:
PERCENTAGE, PERCENTAGE_OF_BASE, FIXED, TIERED, PERCENTAGE_OFF Filter by carrier service code the surcharge applies to.
If true, returns only surcharges marked as waived in the contract.
Last modified on August 25, 2026