Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Subscription Purchases

Retrieve a subscription purchase

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

get/api/v1/subscription-purchases/{subscriptionPurchaseId}

Path parameters

subscriptionPurchaseIdinteger required

Response

Subscription purchase with provided id

idinteger

Id of the subscription purchase

notestring nullable

Note for this subscription purchase

type'pending' | 'diff' | 'unknown' required

Enumerate the possible purchase types for subscription purchases

discountPercentagenumber double

The discount percentage applied to this purchase

discountAbsolutenumber double

The absolute discount applied to this purchase

originalAmountnumber double

The original amount of this purchase

discountAmountnumber double

The discounted amount of this purchase

totalAmountnumber double

The total amount of this purchase

createdAtstring date-time required

Creation date of this subscription purchase

updatedAtstring date-time nullable

Update date of this subscription purchase

deletedAtstring date-time nullable

Deleted date of this subscription purchase

Example response

{
  "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"
}