Skip to content

Subscriptions

Endpoints for interacting with user subscriptions.

Operations

List subscriptions

Request

List all the valid subscriptions that the authorization token has access to.

Security
oauth2(Required scopes: subscription:read)
Query
page_beforestring[a-z]{4}[A-Z\d]{26}

Return results from the page after this ID.

Example:page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_afterstring[a-z]{4}[A-Z\d]{26}

Return results from the page before this ID.

Example:page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_sizeinteger, [ 1 .. 100 ]

Specify the number of results to return per page.

Default:25
Example:page_size=10
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum:"user""offering"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
Accept-Languagestring

Indicates the natural language and locale that the client prefers.

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example:user01HN2NJ9NMRZBXT1H6FT9N7735
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/subscriptions?page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_size=10&expand=user' \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a list of subscriptions.

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 [
idstringsubs[A-Z\d]{26}read-onlyrequired

Unique identifier for the given Subscription.

Example:"subsB1USP6YGD1VPIDJSHTZARUX11M"
urlstring, (uri)read-onlyrequired
Example:"https://api.ev.energy/subscriptions/subsB1USP6YGD1VPIDJSHTZARUX11M"
offering(string or null) or SubscriptionOffering (object)
One of:

Reference of the offering.

string or null (uri)
userstring or User (object)
One of:
string (uri)
]
Response
[
  {
    "id": "subsB1USP6YGD1VPIDJSHTZARUX11M",
    "url": "https://api.ev.energy/subscriptions/subsB1USP6YGD1VPIDJSHTZARUX11M",
    "offering": "https://api.ev.energy/v2/subscription_offerings/suboB1USP6YGD1VPIDJSHTZARUX11M",
    "user": "https://api.ev.energy/v2/user/user01HN2NJ9NMRZBXT1H6FT9N7735"
  }
]