v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Subscription Purchases

Retrieve a list of subscription purchases

Required scope: subscriptions:read </br>Organization authorization: supported

get/api/v1/subscription-purchases

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

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

subscriptionIdinteger nullable

Filter subscription purchases by subscription id

Example:1

includeDeletedboolean nullable

Includes deleted resources in the response

Example:true

Response

List of subscription purchases that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "note": "1",
      "discountPercentage": 25,
      "discountAbsolute": 50,
      "originalAmount": 100,
      "discountAmount": 75,
      "totalAmount": 25,
      "currency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "subscription": {
        "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"
      },
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z",
      "deletedAt": "2022-05-12T16:56:45.99Z"
    }
  ]
}