v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Subscriptions

Retrieve a list of subscriptions

Required scope: subscriptions:read

get/api/v1/subscriptions

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

number of items per page (between 1 and 100, default 10)

planIdinteger nullable

Filter subscription by plan

Example:1

chargePointIdinteger nullable

Filter subscriptions by charge point.</br>Note: This field is deprecated, use customerId instead.

Example:1

customerIdinteger nullable

Filter subscriptions by customer id (charge point or team id). </br>Note: The customerType must also be provided when filtering by customerId.

Example:1

customerType'team' | 'charge-point' | 'operator' | 'other'

Enumerate the various subscription customer types

subscriptionPurchaseIdinteger nullable

Filter subscriptions by subscription purchase id.

Example:42

Response

List of subscriptions that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "nextPurchaseAt": "2023-05-12T15:56:45.99Z",
      "cancelledAt": "2023-05-12T15:56:45.99Z",
      "endAt": "2023-05-12T15:56:45.99Z",
      "validityPeriod": {
        "from": "2024-01-01T00:00:00Z",
        "to": "2024-12-31T23:59:59Z"
      },
      "discountPercentage": 7.5,
      "discountAbsolute": 7.5,
      "discountAmount": 7.5,
      "originalAmount": 7.5,
      "totalAmount": 7.5,
      "purchaseCount": 5,
      "chargePoints": 5,
      "customerId": 1,
      "planId": 42,
      "serviceConfig": {
        "payoutPerKwh": 1.29,
        "priceIncludesVat": true,
        "additionalFeeAbsolute": 0.5,
        "roamingAdditionalFeeAbsolute": 0.5
      },
      "createdAt": "2023-05-12T15:56:45.99Z",
      "updatedAt": "2023-05-12T15:56:45.99Z",
      "canCancel": true,
      "note": "Monthly plan for fleet",
      "deletedAt": "2023-05-12T15:56:45.99Z"
    }
  ]
}