Subscriptions

Retrieve a list of subscriptions

GET

https://partner-api.monta.com

/api/v1/subscriptions

Required scope: subscriptions:read

Retrieve a list of subscriptions › 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

planId

integer | null · int64

Filter subscription by plan

Example: 1

chargePointId

integer | null · int64 · deprecated

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

Example: 1

customerId

integer | null · int64

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

Example: 1

customerType

string · enum

Filter subscriptions by customer type (charge-point or team).

Enum values:

team

charge-point

operator

other

Example: team

subscriptionPurchaseId

integer | null · int64

Filter subscriptions by subscription purchase id.

Example: 42

Retrieve a list of subscriptions › Responses

List of subscriptions that match the criteria

OffsetBasedResponse_57

Subscription[] · required

MontaPage.Meta · required

GET/api/v1/subscriptions

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

Example Responses

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create subscription

POST

https://partner-api.monta.com

/api/v1/subscriptions

Required scope: subscriptions:write
Organization authorization: supported

Create subscription › Request Body

CreateSubscription

customerType

string · enum · required

Type of the customer that the subscription is created for. e.g. team or charge-point

Enum values:

team

charge-point

operator

other

planId

integer · int64

Id of the plan to subscribe to

customerId

integer · int64

Id of the customer the subscription is created for, e.g. team or charge-point id

discountAbsolute

number | null · double · min: 0

Allows to modify the absolute discount on a subscription if provided. If not provided, the discount of the plan is used. Note: If you want to set it on an existing subscription, you have to cancel the subscription first.

discountPercentage

number | null · double · min: 0

Allows to modify the percentage discount on a subscription if provided. If not provided, the discount of the plan is used. Note: If you want to set it on an existing subscription, you have to cancel the subscription first.

object

Configure the subscription, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

userId

integer | null · int64

The user that should be assigned as the purchaser of the subscription. If not provided, the subscription will be assigned to the default user for this consumer.

nextPurchaseAt

string | null · date-time

Date when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Has to be a date in the future.

Example: 2025-10-22T09:30:03Z

sendNotifications

boolean | null

Whether to send the subscription-created notifications (e.g. confirmation email to the team's admins). Defaults to true. Set to false to suppress them, e.g. when migrating existing customers from another CPMS.

Default: true

Create subscription › Responses

The created subscription

Subscription

state

string · enum · required

State of the subscription

Enum values:

pending

active

paused

cancelling

cancelled

unpaid

other

Example: active

customerType

string · enum · required

Customer type

Enum values:

team

charge-point

operator

other

Example: charge-point

createdAt

string · date-time · required

Subscription creation date

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

updatedAt

string · date-time · required

Subscription update date

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

id

integer · int64

Id of the subscription

Example: 1

nextPurchaseAt

string | null · date-time

Date of next purchase

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

cancelledAt

string | null · date-time

Subscription cancellation date

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

endAt

string | null · date-time

Subscription end date

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

object

The validity period of the subscription, exposing the start (from) and end (to) dates as a dedicated object for billing system integrations.

discountPercentage

number · double

Discount percentage

Example: 7.5

discountAbsolute

number · double

Discount absolute

Example: 7.5

discountAmount

number · double

Discount amount

Example: 7.5

originalAmount

number · double

Original amount

Example: 7.5

totalAmount

number · double

Total amount

Example: 7.5

purchaseCount

integer · int32

Number of purchases

Example: 5

chargePoints

integer · int32

Number of charge points

Example: 5

customerId

integer · int64

The id of the customer

Example: 1

planId

integer · int64

Plan id

Example: 42

object

Subscription configuration, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

canCancel

boolean

Indicates if the subscription can be cancelled

Example: true

note

string | null

A note on the subscription

Example: Monthly plan for fleet

deletedAt

string | null · date-time

Subscription marked as deleted date

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

POST/api/v1/subscriptions

curl https://partner-api.monta.com/api/v1/subscriptions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "planId": 1,
  "customerId": 1,
  "customerType": "team",
  "discountAbsolute": 0,
  "discountPercentage": 0,
  "serviceConfig": {
    "serviceType": "tax-refund",
    "payoutPerKwh": 1.29,
    "priceIncludesVat": true,
    "additionalFeeAbsolute": 0.5,
    "roamingAdditionalFeeAbsolute": 0.5
  },
  "userId": 1,
  "nextPurchaseAt": "2025-10-22T09:30:03Z",
  "sendNotifications": true
}'

Example Request Body

{
  "planId": 1,
  "customerId": 1,
  "customerType": "team",
  "discountAbsolute": 0,
  "discountPercentage": 0,
  "serviceConfig": {
    "serviceType": "tax-refund",
    "payoutPerKwh": 1.29,
    "priceIncludesVat": true,
    "additionalFeeAbsolute": 0.5,
    "roamingAdditionalFeeAbsolute": 0.5
  },
  "userId": 1,
  "nextPurchaseAt": "2025-10-22T09:30:03Z",
  "sendNotifications": true
}

json

Example Responses

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

json

application/json

Bulk create subscriptions

POST

https://partner-api.monta.com

/api/v1/subscriptions/bulk

Subscribe a team to multiple plans in one request. Each plan is processed independently — failures do not abort siblings. Required scope: subscriptions:write
Organization authorization: supported

Bulk create subscriptions › Request Body

BulkCreateSubscription

planIds

integer[] · minItems: 1 · maxItems: 50 · required

Ids of plans the team should be subscribed to. Each plan is processed independently — failures do not abort siblings.

teamId

integer · int64

Id of the team that should be subscribed to all selected plans

userId

integer | null · int64

The user that should be assigned as the purchaser of the subscriptions. If not provided, the subscriptions will be assigned to the default user for this consumer.

nextPurchaseAt

string | null · date-time

Date when the wallet will be charged for the first time (ISO8601). Has to be a date in the future.

Example: 2025-10-22T09:30:03Z

sendNotifications

boolean | null

Default: true

Bulk create subscriptions › Responses

Per-plan create results

BulkCreateSubscriptionResult[]

BulkCreateSubscriptionResult

status

string · enum · required

Outcome of the create attempt for this plan

Enum values:

created

failed

Example: created

planId

integer · int64

Plan id this result corresponds to

object

Created subscription, present only when status is created

error

string | null

Failure reason, present only when status is failed

POST/api/v1/subscriptions/bulk

curl https://partner-api.monta.com/api/v1/subscriptions/bulk \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "teamId": 1,
  "planIds": [
    0
  ],
  "userId": 1,
  "nextPurchaseAt": "2025-10-22T09:30:03Z",
  "sendNotifications": true
}'

Example Request Body

{
  "teamId": 1,
  "planIds": [
    0
  ],
  "userId": 1,
  "nextPurchaseAt": "2025-10-22T09:30:03Z",
  "sendNotifications": true
}

json

Example Responses

[
  {
    "planId": 0,
    "status": "created",
    "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"
    },
    "error": "error"
  }
]

json

application/json

Retrieve subscription statistics

GET

https://partner-api.monta.com

/api/v1/subscriptions/stats

Returns aggregate subscription counts and unpaid amount for the calling operator. Required scope: subscriptions:read

Retrieve subscription statistics › Responses

Subscription statistics for the operator

SubscriptionStatsDto

pending_count

integer · int32 · required

active_count

integer · int32 · required

cancelling_count

integer · int32 · required

paused_count

integer · int32 · required

unpaid_count

integer · int32 · required

total_unpaid_amount

number · required

Retrieve a subscription

GET

https://partner-api.monta.com

/api/v1/subscriptions/{subscriptionId}

Required scope: subscriptions:read

Retrieve a subscription › path Parameters

subscriptionId

integer · int64 · required

Retrieve a subscription › Responses

Subscription with provided ID

Subscription

state

string · enum · required

State of the subscription

Enum values:

pending

active

paused

cancelling

cancelled

unpaid

other

Example: active

customerType

string · enum · required

Customer type

Enum values:

team

charge-point

operator

other

Example: charge-point

createdAt

string · date-time · required

Subscription creation date

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

updatedAt

string · date-time · required

Subscription update date

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

id

integer · int64

Id of the subscription

Example: 1

nextPurchaseAt

string | null · date-time

Date of next purchase

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

cancelledAt

string | null · date-time

Subscription cancellation date

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

endAt

string | null · date-time

Subscription end date

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

object

The validity period of the subscription, exposing the start (from) and end (to) dates as a dedicated object for billing system integrations.

discountPercentage

number · double

Discount percentage

Example: 7.5

discountAbsolute

number · double

Discount absolute

Example: 7.5

discountAmount

number · double

Discount amount

Example: 7.5

originalAmount

number · double

Original amount

Example: 7.5

totalAmount

number · double

Total amount

Example: 7.5

purchaseCount

integer · int32

Number of purchases

Example: 5

chargePoints

integer · int32

Number of charge points

Example: 5

customerId

integer · int64

The id of the customer

Example: 1

planId

integer · int64

Plan id

Example: 42

object

Subscription configuration, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

canCancel

boolean

Indicates if the subscription can be cancelled

Example: true

note

string | null

A note on the subscription

Example: Monthly plan for fleet

deletedAt

string | null · date-time

Subscription marked as deleted date

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

GET/api/v1/subscriptions/{subscriptionId}

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

Example Responses

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

json

application/json

Update subscription

PUT

https://partner-api.monta.com

/api/v1/subscriptions/{subscriptionId}

Required scope: subscriptions:write

Update subscription › path Parameters

subscriptionId

integer · int64 · required

Update subscription › Request Body

UpdateSubscription

discountPercentage

number · min: 0 · required

Percentage discount to set on the subscription.

discountAbsolute

number · min: 0 · required

Absolute discount to set on the subscription.

nextPurchaseAt

string · date-time · required

Date when the wallet will next be charged (ISO8601: yyyy-MM-ddTHH:mm:ssZ).

Example: 2025-10-22T09:30:03Z

object

Subscription configuration, based on the plan's serviceType. Currently you can configure tax-refund subscriptions only.

Update subscription › Responses

The updated subscription

Subscription

state

string · enum · required

State of the subscription

Enum values:

pending

active

paused

cancelling

cancelled

unpaid

other

Example: active

customerType

string · enum · required

Customer type

Enum values:

team

charge-point

operator

other

Example: charge-point

createdAt

string · date-time · required

Subscription creation date

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

updatedAt

string · date-time · required

Subscription update date

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

id

integer · int64

Id of the subscription

Example: 1

nextPurchaseAt

string | null · date-time

Date of next purchase

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

cancelledAt

string | null · date-time

Subscription cancellation date

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

endAt

string | null · date-time

Subscription end date

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

object

The validity period of the subscription, exposing the start (from) and end (to) dates as a dedicated object for billing system integrations.

discountPercentage

number · double

Discount percentage

Example: 7.5

discountAbsolute

number · double

Discount absolute

Example: 7.5

discountAmount

number · double

Discount amount

Example: 7.5

originalAmount

number · double

Original amount

Example: 7.5

totalAmount

number · double

Total amount

Example: 7.5

purchaseCount

integer · int32

Number of purchases

Example: 5

chargePoints

integer · int32

Number of charge points

Example: 5

customerId

integer · int64

The id of the customer

Example: 1

planId

integer · int64

Plan id

Example: 42

object

Subscription configuration, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

canCancel

boolean

Indicates if the subscription can be cancelled

Example: true

note

string | null

A note on the subscription

Example: Monthly plan for fleet

deletedAt

string | null · date-time

Subscription marked as deleted date

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

PUT/api/v1/subscriptions/{subscriptionId}

curl https://partner-api.monta.com/api/v1/subscriptions/:subscriptionId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "discountPercentage": 0,
  "discountAbsolute": 0,
  "nextPurchaseAt": "2025-10-22T09:30:03Z",
  "serviceConfig": {
    "serviceType": "tax-refund",
    "payoutPerKwh": 1.29,
    "priceIncludesVat": true,
    "additionalFeeAbsolute": 0.5,
    "roamingAdditionalFeeAbsolute": 0.5
  }
}'

Example Request Body

{
  "discountPercentage": 0,
  "discountAbsolute": 0,
  "nextPurchaseAt": "2025-10-22T09:30:03Z",
  "serviceConfig": {
    "serviceType": "tax-refund",
    "payoutPerKwh": 1.29,
    "priceIncludesVat": true,
    "additionalFeeAbsolute": 0.5,
    "roamingAdditionalFeeAbsolute": 0.5
  }
}

json

Example Responses

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

json

application/json

Cancel subscription

DELETE

https://partner-api.monta.com

/api/v1/subscriptions/{subscriptionId}

Required scope: subscriptions:delete

Cancel subscription › path Parameters

subscriptionId

integer · int64 · required

Cancel subscription › query Parameters

cancellationOption

string · enum

Cancellation option

Enum values:

cancel-immediately

cancel-at-end-of-billing-period

Default: cancel-immediately

Cancel subscription › Responses

Subscription successfully canceled

No data returned

Approve subscription

POST

https://partner-api.monta.com

/api/v1/subscriptions/{subscriptionId}/approve

Required scope: subscriptions:write

Approve subscription › path Parameters

subscriptionId

integer · int64 · required

Approve subscription › Request Body

ApproveSubscription

nextPurchaseAt

string | null · date-time

Date when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ).

Example: 2022-10-22T09:30:03Z

sendNotifications

boolean | null

Whether to send the subscription-approved notifications (e.g. the confirmation or add-a-payment-card email to the team's admins). Defaults to true. Set to false to suppress them, e.g. when migrating existing customers from another CPMS.

Default: true

Approve subscription › Responses

The approved subscription

Subscription

state

string · enum · required

State of the subscription

Enum values:

pending

active

paused

cancelling

cancelled

unpaid

other

Example: active

customerType

string · enum · required

Customer type

Enum values:

team

charge-point

operator

other

Example: charge-point

createdAt

string · date-time · required

Subscription creation date

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

updatedAt

string · date-time · required

Subscription update date

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

id

integer · int64

Id of the subscription

Example: 1

nextPurchaseAt

string | null · date-time

Date of next purchase

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

cancelledAt

string | null · date-time

Subscription cancellation date

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

endAt

string | null · date-time

Subscription end date

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

object

The validity period of the subscription, exposing the start (from) and end (to) dates as a dedicated object for billing system integrations.

discountPercentage

number · double

Discount percentage

Example: 7.5

discountAbsolute

number · double

Discount absolute

Example: 7.5

discountAmount

number · double

Discount amount

Example: 7.5

originalAmount

number · double

Original amount

Example: 7.5

totalAmount

number · double

Total amount

Example: 7.5

purchaseCount

integer · int32

Number of purchases

Example: 5

chargePoints

integer · int32

Number of charge points

Example: 5

customerId

integer · int64

The id of the customer

Example: 1

planId

integer · int64

Plan id

Example: 42

object

Subscription configuration, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

canCancel

boolean

Indicates if the subscription can be cancelled

Example: true

note

string | null

A note on the subscription

Example: Monthly plan for fleet

deletedAt

string | null · date-time

Subscription marked as deleted date

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

POST/api/v1/subscriptions/{subscriptionId}/approve

curl https://partner-api.monta.com/api/v1/subscriptions/:subscriptionId/approve \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "firstPurchaseAt": "2022-10-22T09:30:03Z",
  "nextPurchaseAt": "2022-10-22T09:30:03Z",
  "sendNotifications": true
}'

Example Request Body

{
  "firstPurchaseAt": "2022-10-22T09:30:03Z",
  "nextPurchaseAt": "2022-10-22T09:30:03Z",
  "sendNotifications": true
}

json

Example Responses

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

json

application/json

Preview a subscription cancellation

GET

https://partner-api.monta.com

/api/v1/subscriptions/{subscriptionId}/cancel/preview

Returns the end date and any refund or final purchase that would be applied if the subscription was cancelled now with the given option. Read-only — no state changes. Required scope: subscriptions:read

Preview a subscription cancellation › path Parameters

subscriptionId

integer · int64 · required

Preview a subscription cancellation › query Parameters

cancellationOption

string · enum

Cancellation option to preview

Enum values:

cancel-immediately

cancel-at-end-of-billing-period

Default: cancel-immediately

Preview a subscription cancellation › Responses

Preview of the cancellation outcome

Preview of what would happen if the subscription was cancelled, without performing the cancellation.

SubscriptionCancellationPreview

endAt

string · date-time · required

The date the subscription would end if cancelled with the requested option.

Example: 2025-02-28T23:59:59Z

object

Refund or final-purchase that would result from cancelling now. Null when there is nothing to reconcile (no purchase yet, paid period already elapsed, or end-of-billing-period cancellation).

Renew a subscription

POST

https://partner-api.monta.com

/api/v1/subscriptions/{subscriptionId}/renew

Renews an expired or cancelled subscription, creating a new purchase immediately. Required scope: subscriptions:write

Renew a subscription › path Parameters

subscriptionId

integer · int64 · required

Renew a subscription › Responses

The renewed subscription

Subscription

state

string · enum · required

State of the subscription

Enum values:

pending

active

paused

cancelling

cancelled

unpaid

other

Example: active

customerType

string · enum · required

Customer type

Enum values:

team

charge-point

operator

other

Example: charge-point

createdAt

string · date-time · required

Subscription creation date

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

updatedAt

string · date-time · required

Subscription update date

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

id

integer · int64

Id of the subscription

Example: 1

nextPurchaseAt

string | null · date-time

Date of next purchase

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

cancelledAt

string | null · date-time

Subscription cancellation date

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

endAt

string | null · date-time

Subscription end date

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

object

The validity period of the subscription, exposing the start (from) and end (to) dates as a dedicated object for billing system integrations.

discountPercentage

number · double

Discount percentage

Example: 7.5

discountAbsolute

number · double

Discount absolute

Example: 7.5

discountAmount

number · double

Discount amount

Example: 7.5

originalAmount

number · double

Original amount

Example: 7.5

totalAmount

number · double

Total amount

Example: 7.5

purchaseCount

integer · int32

Number of purchases

Example: 5

chargePoints

integer · int32

Number of charge points

Example: 5

customerId

integer · int64

The id of the customer

Example: 1

planId

integer · int64

Plan id

Example: 42

object

Subscription configuration, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

canCancel

boolean

Indicates if the subscription can be cancelled

Example: true

note

string | null

A note on the subscription

Example: Monthly plan for fleet

deletedAt

string | null · date-time

Subscription marked as deleted date

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

POST/api/v1/subscriptions/{subscriptionId}/renew

curl https://partner-api.monta.com/api/v1/subscriptions/:subscriptionId/renew \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

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

json

application/json

POST

https://partner-api.monta.com

/api/v1/teams/{teamId}/plans/{planId}/subscribe

Required scope: subscriptions:write
Organization authorization: supported

teamId

integer · int64 · required

planId

integer · int64 · required

SubscribeTeamToPlan

userId

integer | null · int64

The user that should be assigned as the purchaser of the subscription. If not provided, the subscription will be assigned to the default user for this consumer.

nextPurchaseAt

string | null · date-time

Date when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Has to be a date in the future.

Example: 2025-10-22T09:30:03Z

The created subscription

Subscription

state

string · enum · required

State of the subscription

Enum values:

pending

active

paused

cancelling

cancelled

unpaid

other

Example: active

customerType

string · enum · required

Customer type

Enum values:

team

charge-point

operator

other

Example: charge-point

createdAt

string · date-time · required

Subscription creation date

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

updatedAt

string · date-time · required

Subscription update date

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

id

integer · int64

Id of the subscription

Example: 1

nextPurchaseAt

string | null · date-time

Date of next purchase

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

cancelledAt

string | null · date-time

Subscription cancellation date

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

endAt

string | null · date-time

Subscription end date

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

object

The validity period of the subscription, exposing the start (from) and end (to) dates as a dedicated object for billing system integrations.

discountPercentage

number · double

Discount percentage

Example: 7.5

discountAbsolute

number · double

Discount absolute

Example: 7.5

discountAmount

number · double

Discount amount

Example: 7.5

originalAmount

number · double

Original amount

Example: 7.5

totalAmount

number · double

Total amount

Example: 7.5

purchaseCount

integer · int32

Number of purchases

Example: 5

chargePoints

integer · int32

Number of charge points

Example: 5

customerId

integer · int64

The id of the customer

Example: 1

planId

integer · int64

Plan id

Example: 42

object

Subscription configuration, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

canCancel

boolean

Indicates if the subscription can be cancelled

Example: true

note

string | null

A note on the subscription

Example: Monthly plan for fleet

deletedAt

string | null · date-time

Subscription marked as deleted date

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

POST/api/v1/teams/{teamId}/plans/{planId}/subscribe

curl https://partner-api.monta.com/api/v1/teams/:teamId/plans/:planId/subscribe \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "userId": 1,
  "nextPurchaseAt": "2025-10-22T09:30:03Z"
}'

Example Request Body

{
  "userId": 1,
  "nextPurchaseAt": "2025-10-22T09:30:03Z"
}

json

Example Responses

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

json

application/json

Subscription Purchases Tariff

Subscriptions

Retrieve a list of subscriptions

Retrieve a list of subscriptions › query Parameters

Retrieve a list of subscriptions › Responses

Create subscription

Create subscription › Request Body

Create subscription › Responses

Bulk create subscriptions

Bulk create subscriptions › Request Body

Bulk create subscriptions › Responses

Retrieve subscription statistics

Retrieve subscription statistics › Responses

Retrieve a subscription

Retrieve a subscription › path Parameters

Retrieve a subscription › Responses

Update subscription

Update subscription › path Parameters

Update subscription › Request Body

Update subscription › Responses

Cancel subscription

Cancel subscription › path Parameters

Cancel subscription › query Parameters

Cancel subscription › Responses

Approve subscription

Approve subscription › path Parameters

Approve subscription › Request Body

Approve subscription › Responses

Preview a subscription cancellation

Preview a subscription cancellation › path Parameters

Preview a subscription cancellation › query Parameters

Preview a subscription cancellation › Responses

Renew a subscription

Renew a subscription › path Parameters

Renew a subscription › Responses

Subscribe a team to a plan

Subscribe a team to a plan › path Parameters

Subscribe a team to a plan › Request Body

Subscribe a team to a plan › Responses