Get all surcharge policies

GET 
/v1/rates/surcharge-policies

Retrieve a paginated list of surcharge policies with optional name filtering

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number for pagination

limit number

Possible values: >= 1

Default value: 10

Number of items per page

name string

Filter by surcharge policy name (case-insensitive)

Responses

200

List of surcharge policies retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the surcharge policy
name stringrequired
The name of the surcharge policy
latestUpdate date-timerequired
The latest update date of the surcharge policy
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "string",
      "name": "Standard Surcharge Policy",
      "latestUpdate": "2025-01-01T00:00:00.000Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

400

Invalid input data

500

Internal server error

Loading...