Accountplans

Retrieve AccountPlan

Function name: m3ter_GetAccountPlan Category: READ HTTP method: GET Destination: m3ter

Retrieve the AccountPlan or AccountPlanGroup details corresponding to the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
integrationCredentialsId	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
id	id	LookupParameter	Yes	The unique identifier (UUID) of the AccountPlan or AccountPlanGroup to retrieve.	-
statePath	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
NEXT	The API call succeeded.
ERROR	The API call failed. Error details are stored in the m3shError state variable.

Update AccountPlan

Function name: m3ter_PutAccountPlan Category: WRITE HTTP method: PUT Destination: m3ter

Update the AccountPlan or AccountPlanGroup with the given UUID.

This endpoint updates a new AccountPlan or AccountPlanGroup for a specific Account in your Organization. The updated information should be provided in the request body.

Notes:

• You cannot use this call to update both an AccountPlan and AccountPlanGroup for an Account at the same time. If you want to update an AccounPlan and an AccountPlanGroup attached to an Account, you must submit two separate calls.
• If you have created Custom Fields for an AccountPlan, when you use this endpoint to update the AccountPlan use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.

Parameters

Name	Label	Type	Required	Description	Constraints
integrationCredentialsId	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
id	id	LookupParameter	Yes	The unique identifier (UUID) of the AccountPlan or AccountPlanGroup to update.	-
requestPath	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
statePath	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
NEXT	The API call succeeded.
ERROR	The API call failed. Error details are stored in the m3shError state variable.

Delete AccountPlan

Function name: m3ter_DeleteAccountPlan Category: WRITE HTTP method: DELETE Destination: m3ter

Delete the AccountPlan or AccountPlanGroup with the given UUID.

This endpoint deletes an AccountPlan or AccountPlanGroup that has been attached to a specific Account in your Organization.

Parameters

Name	Label	Type	Required	Description	Constraints
integrationCredentialsId	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
id	id	LookupParameter	Yes	The unique identifer (UUID) of the AccountPlan or AccountPlanGroup to delete.	-
statePath	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
NEXT	The API call succeeded.
ERROR	The API call failed. Error details are stored in the m3shError state variable.

List AccountPlans

Function name: m3ter_ListAccountPlans Category: READ HTTP method: GET (paginated) Destination: m3ter

Retrieves a list of AccountPlan and AccountPlanGroup entities for the specified Organization. The list can be paginated for easier management, and supports filtering with various query parameters.

Parameters

Name	Label	Type	Required	Description	Constraints
integrationCredentialsId	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
statePath	State Path	StateVariableParameter	No	State variable to store the response.	-
queryParams	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: date,account,plan,product,includeall,ids,contract

Exits

Exit	Description
NEXT	The API call succeeded.
ERROR	The API call failed. Error details are stored in the m3shError state variable.

Create AccountPlan

Function name: m3ter_PostAccountPlan Category: WRITE HTTP method: POST Destination: m3ter

Create a new AccountPlan or AccountPlanGroup.

This endpoint creates a new AccountPlan or AccountPlanGroup for a specific Account in your Organization. The details of the new AccountPlan or AccountPlanGroup should be supplied in the request body.

Note: You cannot use this call to create both an AccountPlan and AccountPlanGroup for an Account at the same time. If you want to create both for an Account, you must submit two separate calls.

Parameters

Name	Label	Type	Required	Description	Constraints
integrationCredentialsId	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
requestPath	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
statePath	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
NEXT	The API call succeeded.
ERROR	The API call failed. Error details are stored in the m3shError state variable.

Replace AccountPlan

Function name: m3ter_ReplaceAccountPlan Category: WRITE HTTP method: POST Destination: m3ter

End-dates the specified AccountPlan at the new startDate and creates the new AccountPlan.

Parameters

Name	Label	Type	Required	Description	Constraints
integrationCredentialsId	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
id	id	LookupParameter	Yes	The UUID of the AccountPlan to replace.	-
requestPath	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
statePath	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
NEXT	The API call succeeded.
ERROR	The API call failed. Error details are stored in the m3shError state variable.