# Get a list of usage rates

Endpoint: GET /usage-rates
Version: 2.21
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `usageRateCardId` (string, required)
    Filter by usage rate card
    Example: "0"

  - `chargeGroupId` (string)
    Filter by charge group
    Example: "0"

  - `usageRateType` (string)
    Filter by usage rate type
    Example: "xyz | in:x,y | like:xyz"

  - `availableFrom` (string)
    Filter by available from date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `availableTo` (string)
    Filter by available to date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

## Response 200 fields (application/json):

  - `id` (integer)
    Usage rate identifier
    Example: 1

  - `chargeGroupId` (integer, required)
    Charge group identifier
    Example: 1

  - `usageRateType` (string, required)
    Usage rate type
    Enum: "MARKUP", "VARIABLE"

  - `peakInitialCharge` (number)
    Peak initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

  - `peakInitialPeriod` (integer, required)
    Peak initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

  - `peakValue` (number, required)
    Peak value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

  - `peakMinimum` (number, required)
    Peak minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

  - `offPeakInitialCharge` (number)
    Offpeak initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

  - `offPeakInitialPeriod` (integer, required)
    Offpeak initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

  - `offPeakValue` (number, required)
    Offpeak value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

  - `offPeakMinimum` (number, required)
    Offpeak minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

  - `weekendInitialCharge` (number)
    Weekend initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

  - `weekendInitialPeriod` (integer, required)
    Weekend initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

  - `weekendValue` (number, required)
    Weekend value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

  - `weekendMinimum` (number, required)
    Weekend minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

  - `quantityRoundingIncrement` (number, required)
    Quantity rounding increment. The chargeable quantity (seconds or megabytes) will be rounded up to the nearest multiple of this value. For example, a 61 second call would be rounded up to 120 seconds if this value is set to an increment of 60. This default value can be overridden at Charge Group level
    Example: 1

  - `variableChargeUnitSize` (integer)
    Variable charge unit size. The unit size in which charges will be calculated.For example, if this value is 60 seconds then the charge is pence (or the minor currency unit) per minute; if this value is 1024 MB then the charge is pence per gigabyte. The default value can be overridden at Charge Group level
    Example: 1

  - `surchargeInitialCharge` (number)
    Surcharge initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

  - `surchargeInitialPeriod` (integer)
    Surcharge initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the surchargeInitialCharge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the surchargeInitialCharge). Any remaining period will be charged at the assigned variable charge (the surchargeValue)

  - `surchargeValue` (number)
    Surcharge value per min. A value of zero will ignore surcharging. If the UPI has applySurcharges and this rate matches then an extra surcharge will be applied as, surchargeValue x the quantity (in mins). The value is pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up

  - `surchargeMinimum` (number)
    Surcharge minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

  - `startDate` (string, required)
    Start date

  - `endDate` (string)
    End date


## Response 400 fields

## Response 401 fields

## Response 403 fields