# List tariffs, sorted alphabetically by name.

List all the energy supplier tariffs known by the ev.energy system.

Use the available_for_user_id query parameter to narrow the list to only those relevant to a specific user and supplier query parameter to list only tariffs for a specific supplier.

Endpoint: GET /tariffs
Version: 2.0
Security: oauth2

## Query parameters:

  - `page` (number)
    The page number to return results for.
    Example: 2

  - `page_size` (integer)
    Specify the number of results to return per page.
    Example: 10

  - `expand` (array)
    Specify a url field to expand into a nested resource. The prices expansion requires tariff:prices:read scope.
    Enum: "supplier", "prices"

  - `supplier_id` (string)
    The ID of the supplier to filter by.

  - `available_for_user_id` (string)
    Filter to only return resources available in the user's region and program.
    Example: "user01HN2NJ9NMRZBXT1H6FT9N7735"

  - `include_optional` (string)
    Include optional tariffs.
    Enum: "daily_prices"

## Header parameters:

  - `EvEnergy-Version` (number)
    Specify the version of this endpoint to use.
    Enum: 2

## Response 200 fields (application/json):

  - `id` (string, required)
    Unique identifier for the given user.
    Example: "tari01HN2NJ9NMRZBXT1H6FT9N7735"

  - `url` (string, required)
    Example: "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735"

  - `supplier` (any, required)
    The energy company that supplies this tariff.

  - `name` (string, required)
    Example: "Fangorn Biomass"

  - `currency` (string, required)
    Example: "GBP"

  - `highlighted` (boolean)
    A highlighted tariff is one that is often selected by users.

  - `type` (any)
    Enum: "FLAT_RATE", "DUAL_RATE", "THREE_RATE", "DYNAMIC", "EXTERNALLY_MANAGED", "OTHER"

  - `daily_prices` (object)
    The times returned here are localised to the timezone the tariff is in.
The timezone is returned in timezone_name.

  - `daily_prices.peak` (object, required)
    A single price for a certain time range.

  - `daily_prices.peak.price` (string)
    The price is in major currency units e.g. 0.10 means £0.10.
    Example: "0.10"

  - `daily_prices.peak.times` (array)

  - `daily_prices.peak.times.start` (string)
    Example: "18:00:00"

  - `daily_prices.peak.times.end` (string)
    Example: "00:00:00"

  - `daily_prices.mid_peak` (object)
    A single price for a certain time range.

  - `daily_prices.off_peak` (object)
    A single price for a certain time range.

  - `timezone_name` (string)
    Example: "Europe/London"

  - `price_chart_url` (string,null)
    The url of a website which can display a chart of prices for the tariff. This website is an external resource and is not affiliated with ev.energy.
    Example: "https://www.example.com/"

## Response 400 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved

## Response 401 fields (application/problem+json):

  - `status` (number)
    Example: 401

  - `title` (string, required)
    Example: "Unauthorized"

  - `detail` (string, required)
    Example: "Authentication credentials were not provided."

## Response 403 fields (application/problem+json):

  - `status` (number)
    Example: 403

  - `title` (string, required)
    Example: "Forbidden"

  - `detail` (string, required)
    Example: "You do not have permission to perform this action."

## Response 404 fields (application/problem+json):

  - `status` (number)
    Example: 404

  - `title` (string, required)
    Example: "Not found"

  - `detail` (string, required)
    Example: "Resource does not exist or cannot be accessed."

## Response 406 fields (application/problem+json):

  - `status` (number)
    Example: 406

  - `title` (string, required)
    Example: "Not Acceptable"

  - `detail` (string, required)
    Example: "Could not satisfy the request Accept header."

## Response 429 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved