List BalanceTransactionSchedule
Function name:m3ter_ListBalanceTransactionSchedule
Category: READ
HTTP method: GET (paginated)
Destination: m3ter
Retrieve a list of BalanceTransactionSchedule entities.
Parameters
Exits
Create BalanceTransactionSchedule
Function name:m3ter_CreateBalanceTransactionSchedule
Category: WRITE
HTTP method: POST
Destination: m3ter
Create a new BalanceTransactionSchedule.
Parameters
Exits
Retrieve BalanceChargeSchedule
Function name:m3ter_GetBalanceChargeSchedule
Category: READ
HTTP method: GET
Destination: m3ter
Retrieve a BalanceChargeSchedule for the given UUID.
Parameters
Exits
Update BalanceChargeSchedule
Function name:m3ter_UpdateBalanceChargeSchedule
Category: WRITE
HTTP method: PUT
Destination: m3ter
Update a BalanceChargeSchedule for the given UUID.
Parameters
Exits
Delete BalanceChargeSchedule
Function name:m3ter_DeleteBalanceChargeSchedule
Category: WRITE
HTTP method: DELETE
Destination: m3ter
Delete the BalanceChargeSchedule for the given UUID.
Parameters
Exits
Preview ScheduledBalanceTransactions
Function name:m3ter_PreviewBalanceTransactionSchedule
Category: WRITE
HTTP method: POST
Destination: m3ter
Previews the BalanceTransactions this Schedule would create, without persisting them. You can use this call to obtain a preview of the Transactions a Schedule you plan to create for a Balance would generate.
Parameters
Exits
List Balances
Function name:m3ter_ListBalances
Category: READ
HTTP method: GET (paginated)
Destination: m3ter
Retrieve a list of all Balances for your Organization.
This endpoint returns a list of all Balances associated with your organization. You can filter the Balances by the end customer’s Account UUID and end dates, and paginate through them using the pageSize and nextToken parameters.
NOTE: If a Balance has a rollover amount configured and you want to use the endDateStart or endDateEnd query parameters, the rolloverEndDate is used as the end date/time for the Balance.
Parameters
Exits
Create Balance
Function name:m3ter_PostBalance
Category: WRITE
HTTP method: POST
Destination: m3ter
Create a new Balance for the given end customer Account.
This endpoint allows you to create a new Balance for a specific end customer Account. The Balance details should be provided in the request body.
Parameters
Exits
List Transactions
Function name:m3ter_ListBalanceTransactions
Category: READ
HTTP method: GET (paginated)
Destination: m3ter
Retrieve all Transactions for a specific Balance.
This endpoint returns a list of all Transactions associated with a specific Balance. You can paginate through the Transactions by using the pageSize and nextToken parameters.
Parameters
Exits
Create Balance Transaction
Function name:m3ter_PostBalanceTransaction
Category: WRITE
HTTP method: POST
Destination: m3ter
Add a Transaction to a Balance. This endpoint allows you to create a new Transaction amount for a Balance. This amount then becomes available at billing for draw-down to cover charges due. The Transaction details should be provided in the request body.
Before you can add a Transaction amount, you must first set up Transaction Types at the Organization Level - see the Transaction Type section in this API Reference for more details. You can then use this call to add an instance of a Transaction Type to a Balance.
Note: If you have a customer whose payment is in a different currency to the Balance currency, you can use the paid and paidCurrency request parameters to record the amount paid and alternative currency respectively. For example, you might add a Transaction amount of 200 USD to a Balance on a customer Account where the customer actually paid you 50 units in virtual currency X.
Parameters
Exits
List BalanceChargeSchedule
Function name:m3ter_ListBalanceChargeSchedule
Category: READ
HTTP method: GET (paginated)
Destination: m3ter
Retrieve a list of BalanceChargeSchedule entities
Parameters
Exits
Create BalanceChargeSchedule
Function name:m3ter_CreateBalanceChargeSchedule
Category: WRITE
HTTP method: POST
Destination: m3ter
Create a new BalanceChargeSchedule.
Parameters
Exits
Get Balance Transactions Summary
Function name:m3ter_GetBalanceTransactionsSummary
Category: READ
HTTP method: GET
Destination: m3ter
Retrieves the Balance Transactions Summary for a given Balance.
The response contains useful recorded and calculated Transaction amounts created for a Balance during the time it is active for the Account, including amounts relevant to any rollover amount configured for a Balance:
totalCreditAmount. The sum of all credits amounts created for the Balance.totalDebitAmount. The sum of all debit amounts created for the Balance.initialCreditAmount. The initial credit amount created for the Balance.expiredBalanceAmount. The amount of the Balance remaining at the time the Balance expires and which is not included in any configured Rollover amount. For example,suppose a Balance reaches its end date and 1000 credit remains unused. If the Balance is configured to rollover 800, then theexpiredBalanceAmountis calculated as 1000 - 800 = 200.rolloverConsumed. The sum of debits made against the configured rollover amount. Note that this amount is dynamic relative to when the API call is made until either the rollover end date is reached or the cap configured for the rollover amount is reached, after which it will be unchanged. If no rollover is configured for a Balance, then this is ignored.balanceConsumed. The sum of debits made against the Balance. Note that this amount is dynamic relative to when the API call is made until either the Balance end date is reached or the available Balance amount reaches zero, after which it will be unchanged.
Parameters
Exits
Preview ScheduledBalanceCharges
Function name:m3ter_PreviewScheduledCharge
Category: WRITE
HTTP method: POST
Destination: m3ter
Previews the Charges this Schedule would create, without persisting them. You can use this call to obtain a preview of the Charges a Schedule you plan to create for a Balance would generate.
Parameters
Exits
Retrieve Balance
Function name:m3ter_GetBalance
Category: READ
HTTP method: GET
Destination: m3ter
Retrieve a specific Balance.
This endpoint returns the details of the specified Balance.
Parameters
Exits
Update Balance
Function name:m3ter_PutBalance
Category: WRITE
HTTP method: PUT
Destination: m3ter
Update a specific Balance.
This endpoint allows you to update the details of a specific Balance. The updated Balance details should be provided in the request body.
Parameters
Exits
Delete Balance
Function name:m3ter_DeleteBalance
Category: WRITE
HTTP method: DELETE
Destination: m3ter
Delete a specific Balance.
This endpoint allows you to delete a specific Balance with the given UUID.
Parameters
Exits
Retrieve BalanceTransactionSchedule
Function name:m3ter_GetBalanceTransactionSchedule
Category: READ
HTTP method: GET
Destination: m3ter
Retrieve a BalanceTransactionSchedule for the given UUID.
Parameters
Exits
Update BalanceTransactionSchedule
Function name:m3ter_UpdateBalanceTransactionSchedule
Category: WRITE
HTTP method: PUT
Destination: m3ter
Update a BalanceTransactionSchedule for the given UUID.
Parameters
Exits
Delete BalanceTransactionSchedule
Function name:m3ter_DeleteBalanceTransactionSchedule
Category: WRITE
HTTP method: DELETE
Destination: m3ter
Delete the BalanceTransactionSchedule for the given UUID.