get_acct_balance_m
Summary
| API Name | get_acct_balance_m |
|---|---|
| Class | account_services_m |
| Update Version | 67 |
Description
Retrieves the current balance and currency for a specified account, broken down by master plan instance (subscription or MPI). Returns the account-level total balance as well as individual MPI balances, showing the outstanding amount owed on each subscription. Balances include all invoiced charges, applied payments, credits, and adjustments. Use this for quick balance checks, payment screens, or account dashboard displays.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| currency_cd | string | No |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
|
| acct_balance | string | No |
The outstanding balance on the account. |
|
| master_plan_instances | object | No | ||
| acct_past_due_balance | double | No |
The outstanding balance on the account that has passed its due date |
master_plan_instances fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| master_plan_instance_no | long | 22 | No |
Unique plan instance number for each assigned master plan. |
| client_def_master_plan_instance_id | string | No |
Client-defined plan instance ID for each assigned master plan. |
|
| master_plan_name | string | No |
Master plan name |
|
| master_plan_instance_desc | string | No |
Description for each assigned master plan |
|
| master_plan_instance_balance | double | No |
Stack balance of each master plan |
|
| master_plan_instance_past_due_balance | double | No |
The outstanding balance on the master plan instance that has passed its due date |