Skip to main content
Aria Knowledge Central

get_acct_open_charges_m Sample Call and Response

This example retrieves the open (unbilled) charges for a specified account, filtered to two particular plan instances, based on the get_acct_open_charges_m method defined in plsql_m_r73.yml.

This example includes every required field, plus the filter_plan_instance array to narrow the results to specific plan instances, rather than every optional filter the method accepts.

Sample call

{
  "rest_call": "get_acct_open_charges_m",
  "output_format": "json",
  "client_no": 3001,
  "auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "acct_no": 900154321,
  "filter_plan_instance": [
    {
      "plan_instance_no": 7734101
    },
    {
      "plan_instance_no": 7734188
    }
  ]
}

The rest_call and output_format fields form the envelope that the REST layer adds to every call; they are not part of the method's own documented arguments. You identify the account using acct_no, the Aria-assigned account identifier, which is one side of an alternative pair with the client-defined client_acct_id; this example uses acct_no. The filter_plan_instance field is an array because an account can have several plan instances, and each entry's plan_instance_no is itself one side of an alternative pair with client_plan_instance_id; this example supplies plan_instance_no for both entries. The two plan instance numbers in this example, 7734101 and 7734188, correspond to a master plan instance and a supplemental plan instance on the same account, so the response below returns charges tied to both.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "total_amount": 239.00,
  "open_charge_items": [
    {
      "proration_no": 0,
      "line_no": 1,
      "posting_date": "2026-07-01",
      "service_no": 8801,
      "service_name": "Monthly Subscription Fee",
      "units": 1,
      "rate_per_unit": 199.00,
      "amount": 199.00,
      "description": "Enterprise Pro monthly subscription charge",
      "plan_no": 4021,
      "plan_name": "Enterprise Pro",
      "plan_instance_no": 7734101,
      "start_date": "2026-07-01",
      "end_date": "2026-07-31"
    },
    {
      "proration_no": 5512,
      "line_no": 2,
      "posting_date": "2026-07-15",
      "service_no": 8802,
      "service_name": "Additional Storage Usage",
      "units": 50,
      "rate_per_unit": 0.50,
      "amount": 25.00,
      "description": "Prorated additional storage usage charge",
      "plan_no": 4550,
      "plan_name": "Additional Storage Add-on",
      "plan_instance_no": 7734188,
      "start_date": "2026-07-15",
      "end_date": "2026-07-31"
    },
    {
      "proration_no": 0,
      "line_no": 3,
      "posting_date": "2026-07-01",
      "service_no": 8803,
      "service_name": "Support Plan Fee",
      "units": 1,
      "rate_per_unit": 15.00,
      "amount": 15.00,
      "description": "Monthly support plan fee",
      "plan_no": 4021,
      "plan_name": "Enterprise Pro",
      "plan_instance_no": 7734101,
      "start_date": "2026-07-01",
      "end_date": "2026-07-31"
    }
  ],
  "charge_mpi_info": [
    {
      "master_plan_instance_no": 7734101,
      "client_master_plan_instance_id": "MPI-ENT-9921",
      "master_plan_no": 4021,
      "client_master_plan_id": "ENTERPRISE-PRO",
      "master_plan_instance_description": "Enterprise Pro Subscription",
      "next_bill_date": "2026-08-01"
    }
  ],
  "charge_spi_info": [
    {
      "master_plan_instance_no": 7734101,
      "supp_plan_instance_no": 7734188,
      "client_supp_plan_instance_id": "SPI-STORAGE-4471",
      "supp_plan_no": 4550,
      "client_supp_plan_id": "ADDL-STORAGE",
      "supp_plan_instance_description": "Additional Storage Add-on",
      "next_bill_date": "2026-08-01"
    }
  ]
}

An error_code value of 0 and an error_msg value of “OK” indicate that Aria processed the request successfully. The open_charge_items array holds one entry per open charge line item; this example shows three representative entries rather than an exhaustive list, and total_amount, 239.00, is the sum of those three line item amounts. The charge_mpi_info and charge_spi_info arrays each hold one entry here because the sample call named exactly one master plan instance and one supplemental plan instance, but on an account with more plan instances in scope, each array would hold correspondingly more entries. This example leaves out the filter_mpi_stack argument, which is an alternative way to filter by master plan instance stack instead of by individual plan instance, and it leaves out several optional fields on each open_charge_items entry, including usage_type_no, master_plan_instance_no, update_date, and comments.

TOP
  • Was this article helpful?