Rebates

List Rebate Types

Request

Retrieve a list of rebate types available to the user.

Security

oauth2

Query

expandArray of strings

Specify a url field to expand into a nested resource.

Items Value:"required_evidence"

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_types?expand=required_evidence' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Return a list of rebate types.

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600

Bodyapplication/json

Array [

idstringread-only

Unique identifier for the RebateType

Example:"rbttB1USP6YGD1VPIDJSHTZARUX11M"

urlstring, (uri)read-only

Example:"https://api.ev.energy/v2/rebate_types/rbttB1USP6YGD1VPIDJSHTZARUX11M"

titlestringread-only

Display name.

Example:"Vehicle Enrollment"

value_descriptionstringread-only

Short text describing the rebate value.

Example:"earn up to $1000"

iconstring or null, (uri)read-only

URI for an icon representing this rebate type.

Example:"https://example.com"

description_longstring or nullread-only

Describes the rebate type.

Example:"Rebate for purchasing an eligible vehicle."

description_shortstring or nullread-only

One line of text containing important information for the rebate type.

Example:"Must be purchased after 11/01/2024"

requirementsstring, (html)read-only

HTML string containing detailed eligibility requirements.

Example:"<html><ul><li>Must be eligible for program</li> <li>Purchased after 11/01/2024</li><li>Must be connected to ev.energy</li></ul></html>"

required_evidenceArray of any

Example:

[
  {
    "title": "string",
    "description": "string",
    "upload_required": true,
    "file": { … },
    "evidence_data": [ … ]
  }
]

]

Response