Monta
Monta API
Monta API

Plans

Retrieve plans

GET
https://partner-api.monta.com
/api/v1/plans

Required scope: plans:read
Organization authorization: supported

Retrieve plans › 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

Retrieve plans › Responses

List of plans that match the criteria

OffsetBasedResponse_41
​Plan[] · required
​MontaPage.Meta · required

Retrieve plan stats

GET
https://partner-api.monta.com
/api/v1/plans/stats

Aggregate plan and subscription stats for the calling operator. Required scope: plans:read
Organization authorization: supported

Retrieve plan stats › Responses

Aggregate plan stats for the operator

PlansStats
​object · required

Projected monthly revenue across plans owned by the calling operator

noSubscriptionCount
​integer · int32

Number of charge points without an active plan subscription

Example: 5
​object

Total tax-refund amount. Null when the operator has no tax-refund plans.

Retrieve a plan

GET
https://partner-api.monta.com
/api/v1/plans/{id}

Required scope: plans:read
Organization authorization: supported

Retrieve a plan › path Parameters

id
​integer · int64 · required

Retrieve a plan › Responses

Plan with provided id

Plan
id
​integer · int64 · required

The id of the Plan

Example: 123
identifier
​string · required

A unique, readable, identifier of the Plan

Example: plan-monta-123
name
​string · required

Name of the Plan

Example: ACME GOLD
applicableFor
​string · enum · required

Indicates whether this plan can be applied to teams or charge points. 'operator' value is only used internally.

Enum values:
charge-point
team
operator
Example: charge-point
active
​boolean · required

Indicates if the plan is active (only active plans can be applied).

Example: true
applicationAudience
​string · enum · required

Indicates whether this plan is shown in your (operator's) app only, or in the Monta app as well.

Enum values:
all
own
Example: all
visibleInMarketPlace
​boolean · required

Indicates whether this plan is shown in the market place or not.

Example: true
priceModel
​string · enum · required

Indicates if the price is fixed, per charge point or per user.

Enum values:
fixed
per-charge-point
per-user
Example: fixed
​PlanPrice[] · required

Active plan prices

pricesWithVat
​boolean · required

Indicates if the prices are incl. VAT or not. Default is true.

serviceType
​string · enum · required

Plan service type, custom, tax-refund or charge-package

Enum values:
custom
tax-refund
charge-package
Example: tax-refund
​object · required

Additional configuration, based on serviceType

countryId
​integer | null · int64

Determines the country where the plan is available. null means it is available in all countries.

Example: 1
description
​string | null

Description of the Plan

Example: Charge Point Maintenance 24/7
summary
​string | null

Summary of the Plan

Example: GOLD Maintenance Plan for ACME customers
terms
​string | null

Terms of the Plan

Example: Your terms here
contractUrl
​string | null

URL for a generic contract template the user can fill out right after subscribing

Example: https://www.monta.com/contract.pdf
supportEmail
​string | null

Support E-Mail for this Plan

Example: support@acme.com
Payment TerminalsPrice Groups