Subscription Purchases

Retrieve a list of subscription purchases

GET

https://partner-api.monta.com

/api/v1/subscription-purchases

Required scope: subscriptions:read
Organization authorization: supported

Retrieve a list of subscription purchases › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

subscriptionId

integer | null · int64

Filter subscription purchases by subscription id

Example: 1

includeDeleted

boolean | null

Includes deleted resources in the response

Example: true

Retrieve a list of subscription purchases › Responses

List of subscription purchases that match the criteria

OffsetBasedResponse_58

SubscriptionPurchase[] · required

MontaPage.Meta · required

GET/api/v1/subscription-purchases

curl https://partner-api.monta.com/api/v1/subscription-purchases \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "note": "1",
      "type": "period",
      "discountPercentage": 25,
      "discountAbsolute": 50,
      "originalAmount": 100,
      "discountAmount": 75,
      "totalAmount": 25,
      "currency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "subscription": {
        "id": 1,
        "state": "active",
        "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,
        "customerType": "charge-point",
        "planId": 42,
        "serviceConfig": {
          "serviceType": "tax-refund",
          "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"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Retrieve a subscription purchase

GET

https://partner-api.monta.com

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

Required scope: subscriptions:read
Organization authorization: supported

Retrieve a subscription purchase › path Parameters

subscriptionPurchaseId

integer · int64 · required

Retrieve a subscription purchase › Responses

Subscription purchase with provided id

SubscriptionPurchase

type

string · enum · required

The type of this subscription purchase

Enum values:

pending

diff

unknown

Example: period

object · required

The currency for this purchase

object · required

The subscription this purchase refers to

createdAt

string · date-time · required

Creation date of this subscription purchase

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

Id of the subscription purchase

Example: 1

note

string | null

Note for this subscription purchase

Example: 1

discountPercentage

number · double

The discount percentage applied to this purchase

Example: 25

discountAbsolute

number · double

The absolute discount applied to this purchase

Example: 50

originalAmount

number · double

The original amount of this purchase

Example: 100

discountAmount

number · double

The discounted amount of this purchase

Example: 75

totalAmount

number · double

The total amount of this purchase

Example: 25

updatedAt

string | null · date-time

Update date of this subscription purchase

Example: 2022-05-12T16:56:45.99Z

deletedAt

string | null · date-time

Deleted date of this subscription purchase

Example: 2022-05-12T16:56:45.99Z

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

curl https://partner-api.monta.com/api/v1/subscription-purchases/:subscriptionPurchaseId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "note": "1",
  "type": "period",
  "discountPercentage": 25,
  "discountAbsolute": 50,
  "originalAmount": 100,
  "discountAmount": 75,
  "totalAmount": 25,
  "currency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "subscription": {
    "id": 1,
    "state": "active",
    "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,
    "customerType": "charge-point",
    "planId": 42,
    "serviceConfig": {
      "serviceType": "tax-refund",
      "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"
}

json

application/json