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
Exits
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
customFieldsparameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.
Parameters
Exits
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
Exits
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
Exits
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
Exits
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.