MOmonta
Plans

Retrieve a plan

Changed on

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

get/api/v1/plans/{id}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/plans/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

Response

Plan with provided id

idinteger required

The id of the Plan

identifierstring required

A unique, readable, identifier of the Plan

namestring required

Name of the Plan

countryIdinteger nullable

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

descriptionstring nullable

Description of the Plan

summarystring nullable

Summary of the Plan

termsstring nullable

Terms of the Plan

contractUrlstring nullable

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

supportEmailstring nullable

Support E-Mail for this Plan

applicableFor'charge-point' | 'team' | 'operator' required
activeboolean required

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

applicationAudience'all' | 'own' required
visibleInMarketPlaceboolean required

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

priceModel'fixed' | 'per-charge-point' | 'per-user' required
pricesWithVatboolean required

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

serviceType'custom' | 'tax-refund' | 'charge-package' required

Example response

{
  "id": 123,
  "identifier": "plan-monta-123",
  "name": "ACME GOLD",
  "countryId": 1,
  "description": "Charge Point Maintenance 24/7",
  "summary": "GOLD Maintenance Plan for ACME customers",
  "terms": "Your terms here",
  "contractUrl": "https://www.monta.com/contract.pdf",
  "supportEmail": "support@acme.com",
  "active": true,
  "visibleInMarketPlace": true,
  "prices": [
    {
      "id": 1,
      "price": 4.99,
      "currency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      }
    }
  ],
  "serviceConfig": {
    "additionalFeePercentage": 2,
    "additionalFeeAbsolute": 0.5,
    "additionalStartingFee": 0.5,
    "roamingAdditionalFeePercentage": 2,
    "roamingAdditionalFeeAbsolute": 0.5,
    "roamingAdditionalStartingFee": 0.5
  }
}

Changes

  • 0ca400461c52Revision changes
    • warning

      added the new per-user enum value to the //// response property for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status