Skip to main content
GET
List contract surcharges

Authorizations

Authorization
string
header
required

HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).

Path Parameters

contract_id
string
required

ID of the contract.

Query Parameters

limit
integer
default:50

Number of items to return per request.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response. Omit on the first request.

Free-text search against the surcharge display name.

billing_type
enum<string>

Filter by how the surcharge is billed.

Available options:
PERCENTAGE,
PERCENTAGE_OF_BASE,
FIXED,
TIERED,
PERCENTAGE_OFF
service_type
string

Filter by carrier service code the surcharge applies to.

is_waived
boolean

If true, returns only surcharges marked as waived in the contract.

Response

Cursor-paginated surcharges.

data
object[]
required
pagination
object
required