How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

M3ter AccountPlan API

Endpoints for AccountPlan and AccountPlanGroup related operations such as creation, update, list and delete. **AccountPlans**An Account represents one of your end-customer accounts. To create an AccountPlan, you attach a Product Plan to an Account. The AccountPlan then determines the charges incurred at billing by your end customer for consuming the Product the Plan is for:* **AccountPlan Active/Inactive**. Set start and end dates to define the period the AccountPlan is active for the Account.* **AccountPlan per Product**. If an end customer consumes multiple Products, create separate AccountPlans to charge for each Product.**AccountPlan Constraints:*** Only one AccountPlan per Product can be active at any one time for an Account.* If you create a Plan as a custom Plan for a specific Account, you can only use it to create an AccountPlan for that Account.**AccountPlanGroups**Plan Groups are used when you want to apply a minimum spend amount at billing across several of your Products each of which are priced separately - when you create the Plan Group, you define an overall minimum spend and then add any priced Plans you want to include in the Group. To create an AccounPlanGroup, you can attach a Plan Group to an Account that consumes the separate Products which are priced using the included Plans. At billing, the minimum spend you've defined for the Plan Group is applied:* **Active AccountPlanGroup**. Set the start and end dates to define the period for which the Plan Group will be active for the Account.**Plan Group Notes:*** You can only add *one Plan for the same Product* to a Plan Group. See the [Plan Group](https://www.m3ter.com/docs/api#tag/PlanGroup) in this API Reference for more details on creating Plan Groups.* You can create a *custom Plan Group* for an Account, which means the Plan Group can only be attached to that Account to create an AccountPlanGroup.**AcountPlanGroup - Notes and Constraints:*** **AccountPlanGroup is type of AccountPlan** When you attach a Plan Group to an Account, this creates an AccountPlanGroup. However, the m3ter data model *does not support a separate AccountPlanGroup entity*, and an AccountPlanGroup is a type of AccountPlan where a `planGroupId` is used instead of a `planId` when it's created. See the [Create AccountPlan](https://www.m3ter.com/docs/api#tag/AccountPlan/operation/PostAccountPlan) call in this section and [Attaching Plan Groups to an Account](https://www.m3ter.com/docs/guides/end-customer-accounts/attaching-plan-groups-to-an-account) in our main User Documentation.* **Multiple AccountPlan Groups:** You can attach more than one Plan Group to an Account to create multiple AccountPlanGroups, but the rule that *only one attached Plan per Product can be active at any one time for an Account* is preserved: * Multiple attached Plan Groups on an Account can have overlapping dates only if none of the Plan Groups contain a Plan belonging to the same Product. If you try to attach a Plan Group to an Account with Plan Groups already attached and: * The new Plan Group contains a Product Plan that also belongs to a Plan Group already attached to the Account. * The dates for these "matched Plan" Plan Groups being active for the Account would overlap. * Then you'll receive an error and the attachment will be blocked.

M3ter AccountPlan API is one of 58 APIs that M3ter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AccountPlan. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

This API exposes 6 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.m3ter.com.

6 operations 3 paths 9 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.m3ter.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

M3ter AccountPlan API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials and authorizationCode flows, exposing 6 scopes. By default, every request must be authenticated.

  • OAuth2 — m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow. The authorizationCode flow controls access for human users via the m3…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

AccountPlan 6

Endpoints for AccountPlan and AccountPlanGroup related operations such as creation, update, list and delete. AccountPlans An Account represents one of your end-customer accounts.…

GET
/organizations/{orgId}/accountplans/{id}
Retrieve AccountPlan
GetAccountPlan 2 params → 2004XX5XX
PUT
/organizations/{orgId}/accountplans/{id}
Update AccountPlan
PutAccountPlan 2 params body → 2004XX5XX
DELETE
/organizations/{orgId}/accountplans/{id}
Delete AccountPlan
DeleteAccountPlan 2 params → 2004XX5XX
GET
/organizations/{orgId}/accountplans
List AccountPlans
ListAccountPlans 10 params → 2004XX5XX
POST
/organizations/{orgId}/accountplans
Create AccountPlan
PostAccountPlan 1 param body → 2004XX5XX
POST
/organizations/{orgId}/accountplans/{id}/replace
Replace AccountPlan
ReplaceAccountPlan 2 params body → 2004XX5XX

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are AbstractResponse (2 properties), ReplaceAccountPlanResponse (2 properties), PaginatedAccountPlanResponseData (2 properties), AbstractRequest (1 property). Each schema is shown below with its type and property counts.

PaginatedAccountPlanResponseData
object
2 properties
AccountPlanRequest
object
AbstractRequestWithCustomFields
object
AbstractResponse
object
2 properties 1 required
AccountPlanResponse
object
ChildBillingMode
string
If the Account is either a Parent or a Child Account, this specifies the Account hierarchy billing mode. The mode determines how billing will be handled and sh…
ReplaceAccountPlanResponse
object
2 properties
AbstractRequest
object
1 property
AbstractResponseWithCustomFields
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

m3ter-accountplan-api-openapi.yml Raw ↑

Other APIs M3ter publishes across the network.

M3ter Account API
M3ter Aggregation API
M3ter Auth API
M3ter BalanceChargeSchedule API
M3ter Balances API
M3ter BalanceTransactionSchedule API
M3ter Bill API
M3ter BillConfig API
M3ter BillGroupingKey API
M3ter BillJob API
M3ter Charge API
M3ter Commitments API
Where this information came from

This is an independent, third-party profile of M3ter AccountPlan API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.