Skip to main content

​
List Contracts

Function name: m3ter_ListContracts Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieves a list of Contracts by Organization ID. Supports pagination and includes various query parameters to filter the Contracts returned based on Contract IDs or short codes.

​
Parameters

​
Exits

​
Create Contract

Function name: m3ter_PostContract Category: WRITE HTTP method: POST Destination: m3ter Creates a new Contract for the specified Account. The Contract includes information such as the associated Account along with start and end dates. If you intend to bill an Account on a Contract basis, you can use the billGroupingKeyId, applyContractPeriodLimits, and usageFilters request parameters to control Contract billing.

​
Parameters

​
Exits

​
Retrieve Contract

Function name: m3ter_GetContract Category: READ HTTP method: GET Destination: m3ter Retrieves the Contract with the given UUID. Used to obtain the details of a Contract.

​
Parameters

​
Exits

​
Update Contract

Function name: m3ter_PutContract Category: WRITE HTTP method: PUT Destination: m3ter Update the Contract with the given UUID. This endpoint updates the details of the Contract with the specified ID. Used to modify details of an existing Contract such as the start or end dates. Note: If you have created Custom Fields for a Contract, when you use this endpoint to update the Contract use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.

​
Parameters

​
Exits

​
Delete Contract

Function name: m3ter_DeleteContract Category: WRITE HTTP method: DELETE Destination: m3ter Deletes the Contract with the specified UUID. Used to remove an existing Contract from an Account. Note: This call will fail if there are any other billing entities associated with the Account and that have been added to the Contract, such as AccountPlans, Balance, or Commitments.

​
Parameters

​
Exits

​
End-date Contract Account billing entities

Function name: m3ter_EndDateBillingEntitiesForContract Category: WRITE HTTP method: PUT Destination: m3ter Apply the specified end-date to billing entities associated with Accounts the Contract has been added to, and apply the end-date to the Contract itself. NOTES:
  • If you want to apply the end-date to the Contract itself - the Contract id you use as the required PATH PARAMETER - you must also specify CONTRACT as a billingEntities option in the request body schema.
  • Only the Contract whose id you specify for the PATH PARAMETER will be end-dated. If there are other Contracts associated with the Account, these will not be end-dated.
  • When you successfully end-date billing entities, the version number of each entity is incremented.

​
Parameters

​
Exits