Skip to main content
Aria Knowledge Central

Sample XML Payloads for Events in the Account and Master Plan Instances Class

  1. Last updated
  2. Save as PDF
  1. Use Case 1: New Account Creation with Master Plan Instance
  2. Use Case 2: Account Modification with Installment Data
  3. Use Case 3: Account Deletion with Multiple Master Plan Instances
  4. Use Case 4: Payment Plan Creation
  5. Use Case 5: Coupon Assigned
  6. Key Notes for Developers

Use Case 1: New Account Creation with Master Plan Instance

This payload represents a new account creation event (action="A") triggered by Aria (sender="A"). It includes basic account details (acct_data) and a single master plan instance (master_plan_instance_data). Developers should note the mandatory fields in <request> (e.g., version, sender, transaction_id, action, class_name) and ensure the class_name is set to "A" for account/MPI events. The <master_plan_instance> includes billing-related dates under <mpi_billing_dates>, which are critical for tracking billing cycles.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
  <request>
    <version>3.8</version>
    <sender>A</sender>
    <transaction_id>123456</transaction_id>
    <action>A</action>
    <class_name>A</class_name>
    <auth_key>xyz789</auth_key>
    <client_receipt_id>receipt_001</client_receipt_id>
  </request>
  <acct_data>
    <client_no>1001</client_no>
    <acct_no>987654</acct_no>
    <client_acct_id>ACCT_001</client_acct_id>
    <userid>john.doe</userid>
    <password>securepass123</password>
    <status_cd>1</status_cd>
    <notify_method>1</notify_method>
    <currency>USD</currency>
    <test_acct>N</test_acct>
    <last_acct_comment>Account created successfully</last_acct_comment>
  </acct_data>
  <acct_contact>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <email>john.doe@example.com</email>
    <address1>123 Main St</address1>
    <city>San Francisco</city>
    <state_prov>CA</state_prov>
    <postal_code>94105</postal_code>
    <country>US</country>
    <phone>555-123-4567</phone>
  </acct_contact>
  <master_plan_instance_data>
    <master_plan_instance>
      <master_plan_instance_no>500001</master_plan_instance_no>
      <client_master_plan_instance_id>MPI_001</client_master_plan_instance_id>
      <plan_no>2001</plan_no>
      <client_plan_id>PLAN_001</client_plan_id>
      <plan_name>Premium Subscription</plan_name>
      <plan_activation_date>2025-08-20</plan_activation_date>
      <status_cd>1</status_cd>
      <resp_level_cd>1</resp_level_cd>
      <plan_units>1.0</plan_units>
      <billing_group_no>3001</billing_group_no>
      <client_billing_group_id>BG_001</client_billing_group_id>
      <mpi_billing_dates>
        <bill_day>20</bill_day>
        <created_date>2025-08-20</created_date>
        <next_bill_date>2025-09-20</next_bill_date>
      </mpi_billing_dates>
    </master_plan_instance>
  </master_plan_instance_data>
</apf2doc>

Use Case 2: Account Modification with Installment Data

This payload demonstrates an account modification event (action="M") that includes an installment payment scenario (installment_data). Developers should focus on the <installment_data> structure, which ties an installment to a specific invoice, billing group, and master plan instance. The installment_no and client_installment_term_id are required fields, while optional fields like installment_status provide additional context. This use case also includes a billing group and payment method for a complete picture of the account's financial setup.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="account_mpi_prov.xsd">
  <request>
    <version>4.0</version>
    <sender>A</sender>
    <transaction_id>987654321</transaction_id>
    <action>M</action> <!-- M = Modify -->
    <class_name>A</class_name>
    <client_receipt_id>CLIENT-REC-20260105-002</client_receipt_id>
  </request>

  <acct_data>
    <client_no>98765</client_no>
    <acct_no>50001234</acct_no>
    <client_acct_id>CUST-10001</client_acct_id>
    <userid>john.doe@example.com</userid>
    <status_cd>1</status_cd>
    <currency>USD</currency>
    <test_acct>N</test_acct>
    <last_acct_comment>Account modified - installment schedule added on 2026-01-05</last_acct_comment>
  </acct_data>

  <acct_contact>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <company_name>Acme Corp</company_name>
    <address1>123 Main Street</address1>
    <city>Anytown</city>
    <state_prov>CA</state_prov>
    <postal_code>90210</postal_code>
    <country>US</country>
    <email>john.doe@example.com</email>
    <phone>555-123-4567</phone>
  </acct_contact>

  <!-- Existing Master Plan Instance (unchanged in this example) -->
  <master_plan_instance_data>
    <master_plan_instance>
      <master_plan_instance_no>4000123</master_plan_instance_no>
      <client_master_plan_instance_id>MPI-10001</client_master_plan_instance_id>
      <plan_no>101</plan_no>
      <client_plan_id>PREMIUM-MONTHLY</client_plan_id>
      <plan_name>Premium Monthly Plan</plan_name>
      <plan_activation_date>2026-01-05</plan_activation_date>
      <status_cd>1</status_cd>
      <plan_units>1.00</plan_units>
      <billing_group_no>20001</billing_group_no>
      <client_billing_group_id>BG-001</client_billing_group_id>
      <mpi_billing_dates>
        <bill_day>5</bill_day>
        <next_bill_date>2026-02-05</next_bill_date>
      </mpi_billing_dates>
    </master_plan_instance>
  </master_plan_instance_data>

  <!-- Installment Data - this is the key section for the event -->
  <!-- Example: A one-time setup fee of $300 is split into 3 monthly installments -->
  <installment_data>
    <installment_no>90001</installment_no>
    <client_installment_term_id>INST-3MONTH</client_installment_term_id>
    <installment_status>Active</installment_status>
    <status_change_date>2026-01-05</status_change_date>
    <invoice_no>80005678</invoice_no> <!-- The original invoice being paid in installments -->
    <billing_group_no>20001</billing_group_no>
    <master_plan_instance_no>4000123</master_plan_instance_no>
  </installment_data>

  <!-- Optional: Include payment method if relevant to the modification -->
  <payment_method_data>
    <payment_method>
      <payment_method_no>30001</payment_method_no>
      <client_payment_method_id>PM-001</client_payment_method_id>
      <pay_method>1</pay_method> <!-- Credit Card -->
      <cc_suffix>1111</cc_suffix>
      <cc_exp_mm>12</cc_exp_mm>
      <cc_exp_yyyy>2028</cc_exp_yyyy>
    </payment_method>
  </payment_method_data>

  <!-- Triggering event(s) -->
  <event_data>
    <event>
      <event_id>1010</event_id>
      <event_label>Account Modified</event_label>
    </event>
    <event>
      <event_id>3005</event_id>
      <event_label>Installment Schedule Created</event_label>
    </event>
  </event_data>
</apf2doc>

Use Case 3: Account Deletion with Multiple Master Plan Instances

This payload represents an account deletion event (action="D") with multiple master plan instances (master_plan_instance_data). Developers should note the use of maxOccurs="unbounded" in <master_plan_instance>, allowing multiple plans to be associated with an account. The <event_data> section includes multiple events to indicate the triggers for deletion. Ensure all required fields (e.g., master_plan_instance_no) are populated for each instance, and optional fields like plan_termination_date can provide context for the deletion.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
  <request>
    <version>3.8</version>
    <sender>A</sender>
    <transaction_id>123458</transaction_id>
    <action>D</action>
    <class_name>A</class_name>
    <auth_key>xyz791</auth_key>
    <client_receipt_id>receipt_003</client_receipt_id>
  </request>
  <acct_data>
    <client_no>1001</client_no>
    <acct_no>987654</acct_no>
    <client_acct_id>ACCT_001</client_acct_id>
    <userid>john.doe</userid>
    <status_cd>0</status_cd>
    <notify_method>1</notify_method>
    <currency>USD</currency>
    <test_acct>N</test_acct>
    <last_acct_comment>Account deleted</last_acct_comment>
  </acct_data>
  <acct_contact>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <email>john.doe@example.com</email>
    <address1>123 Main St</address1>
    <city>San Francisco</city>
    <state_prov>CA</state_prov>
    <postal_code>94105</postal_code>
    <country>US</country>
    <phone>555-123-4567</phone>
  </acct_contact>
  <master_plan_instance_data>
    <master_plan_instance>
      <master_plan_instance_no>500001</master_plan_instance_no>
      <client_master_plan_instance_id>MPI_001</client_master_plan_instance_id>
      <plan_no>2001</plan_no>
      <client_plan_id>PLAN_001</client_plan_id>
      <plan_name>Premium Subscription</plan_name>
      <plan_activation_date>2025-08-20</plan_activation_date>
      <plan_termination_date>2025-08-20</plan_termination_date>
      <status_cd>0</status_cd>
      <resp_level_cd>1</resp_level_cd>
      <plan_units>1.0</plan_units>
      <billing_group_no>3001</billing_group_no>
      <client_billing_group_id>BG_001</client_billing_group_id>
      <mpi_billing_dates>
        <bill_day>20</bill_day>
        <created_date>2025-08-20</created_date>
        <next_bill_date>2025-09-20</next_bill_date>
      </mpi_billing_dates>
    </master_plan_instance>
    <master_plan_instance>
      <master_plan_instance_no>500002</master_plan_instance_no>
      <client_master_plan_instance_id>MPI_002</client_master_plan_instance_id>
      <plan_no>2002</plan_no>
      <client_plan_id>PLAN_002</client_plan_id>
      <plan_name>Basic Subscription</plan_name>
      <plan_activation_date>2025-08-20</plan_activation_date>
      <plan_termination_date>2025-08-20</plan_termination_date>
      <status_cd>0</status_cd>
      <resp_level_cd>1</resp_level_cd>
      <plan_units>1.0</plan_units>
      <billing_group_no>3002</billing_group_no>
      <client_billing_group_id>BG_002</client_billing_group_id>
      <mpi_billing_dates>
        <bill_day>20</bill_day>
        <created_date>2025-08-20</created_date>
        <next_bill_date>2025-09-20</next_bill_date>
      </mpi_billing_dates>
    </master_plan_instance>
  </master_plan_instance_data>
</apf2doc>

Use Case 4: Payment Plan Creation

This sample payload represents the "Account Payment Plan Created" event. Developers should focus on the <payment_plan_data> element, which captures critical details like the payment plan number, client ID, length, period type, interval, first due date, and recurring payment amount. The event_data section is crucial as it specifies the event triggering the notification (event_label set to "Account Payment Plan Created"). The <billing_group_data> and <master_plan_instance_data> elements tie the payment plan to the relevant billing group and master plan instance, ensuring proper association with the account. The request section must include the correct version (minimum version 3.8), sender ("A" for Aria), and action ("A" for add), as these are required for proper event processing. Optional fields like <acct_contact> and <notify_tmplt_group_data> can be included based on your integration needs but are omitted here for simplicity.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="account_mpi_prov.xsd">
  <request>
    <version>4.0</version>
    <sender>A</sender>
    <transaction_id>5555667788</transaction_id>
    <action>A</action> <!-- A = Add (creation of the payment plan) -->
    <class_name>A</class_name>
    <client_receipt_id>CLIENT-REC-20260105-003</client_receipt_id>
  </request>

  <acct_data>
    <client_no>98765</client_no>
    <acct_no>50001234</acct_no>
    <client_acct_id>CUST-10001</client_acct_id>
    <userid>john.doe@example.com</userid>
    <status_cd>1</status_cd>
    <currency>USD</currency>
    <test_acct>N</test_acct>
    <last_acct_comment>Payment plan created on account on 2026-01-05</last_acct_comment>
  </acct_data>

  <acct_contact>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <company_name>Acme Corp</company_name>
    <address1>123 Main Street</address1>
    <city>Anytown</city>
    <state_prov>CA</state_prov>
    <postal_code>90210</postal_code>
    <country>US</country>
    <email>john.doe@example.com</email>
    <phone>555-123-4567</phone>
  </acct_contact>

  <!-- Existing Master Plan Instance (included for context) -->
  <master_plan_instance_data>
    <master_plan_instance>
      <master_plan_instance_no>4000123</master_plan_instance_no>
      <client_master_plan_instance_id>MPI-10001</client_master_plan_instance_id>
      <plan_no>101</plan_no>
      <client_plan_id>PREMIUM-MONTHLY</client_plan_id>
      <plan_name>Premium Monthly Plan</plan_name>
      <plan_activation_date>2026-01-05</plan_activation_date>
      <status_cd>1</status_cd>
      <plan_units>1.00</plan_units>
      <billing_group_no>20001</billing_group_no>
      <client_billing_group_id>BG-001</client_billing_group_id>
    </master_plan_instance>
  </master_plan_instance_data>

  <!-- Payment Plan Data - the key section for this event -->
  <!-- Example: $600 total balance spread over 6 monthly payments of $100 each -->
  <payment_plan_data>
    <payment_plan_no>70001</payment_plan_no>
    <client_payment_plan_id>PP-6MONTH-001</client_payment_plan_id>
    <payment_plan_length>6</payment_plan_length>
    <payment_plan_period_type>Monthly</payment_plan_period_type>
    <payment_plan_interval>1</payment_plan_interval>
    <first_payment_plan_due_date>2026-02-05</first_payment_plan_due_date>
    <recurring_payment_amount>100.00</recurring_payment_amount>
    <payment_plan_bg_no>20001</payment_plan_bg_no>
    <!-- Comma-separated lists of associated objects (as strings) -->
    <invoice_list>80005678,80005679</invoice_list>
    <charge_list>9000123,9000456</charge_list>
    <mpi_list>4000123</mpi_list>
    <payment_plan_status>Active</payment_plan_status>
    <payment_plan_status_change_date>2026-01-05</payment_plan_status_change_date>
  </payment_plan_data>

  <!-- Payment method used for recurring payments on the plan -->
  <payment_method_data>
    <payment_method>
      <payment_method_no>30001</payment_method_no>
      <client_payment_method_id>PM-001</client_payment_method_id>
      <pay_method>1</pay_method> <!-- 1 = Credit Card -->
      <cc_suffix>1111</cc_suffix>
      <cc_exp_mm>12</cc_exp_mm>
      <cc_exp_yyyy>2028</cc_exp_yyyy>
    </payment_method>
  </payment_method_data>

  <!-- Triggering event(s) -->
  <event_data>
    <event>
      <event_id>4001</event_id>
      <event_label>Payment Plan Created</event_label>
    </event>
    <event>
      <event_id>1010</event_id>
      <event_label>Account Modified</event_label>
    </event>
  </event_data>
</apf2doc>

Use Case 5: Coupon Assigned

This payload represents a Coupon Assigned event in Aria Systems' event notification schema. The M indicates a modification because assigning a coupon alters either the account or the associated plan instance. The key information resides in the  section, which includes the coupon code (e.g., "PROMO2026"), the Aria-assigned unique coupon assignment number, the assignment level (in this case, 2 for Master Plan Instance level), and the specific master plan instance number to which the coupon applies. For supplemental plan assignments, the <plan_instance_no> would be used instead. The same coupon code is also reflected in the field within the master plan instance data for additional context and consistency. Surrounding sections, such as account data, contact information, master plan instance details, and payment method, provide the current state of the account following the coupon assignment. The section lists "Coupon Assigned" as the primary triggering event, accompanied by a related "Master Plan Instance Modified" event to fully describe what prompted the notification. 

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="account_mpi_prov.xsd">
  <request>
    <version>4.0</version>
    <sender>A</sender>
    <transaction_id>1122334455</transaction_id>
    <action>M</action> <!-- M = Modify (coupon assignment modifies the account/MPI) -->
    <class_name>A</class_name>
    <client_receipt_id>CLIENT-REC-20260105-004</client_receipt_id>
  </request>

  <acct_data>
    <client_no>98765</client_no>
    <acct_no>50001234</acct_no>
    <client_acct_id>CUST-10001</client_acct_id>
    <userid>john.doe@example.com</userid>
    <status_cd>1</status_cd>
    <currency>USD</currency>
    <test_acct>N</test_acct>
    <last_acct_comment>Coupon PROMO2026 assigned to Master Plan Instance on 2026-01-05</last_acct_comment>
  </acct_data>

  <acct_contact>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <company_name>Acme Corp</company_name>
    <address1>123 Main Street</address1>
    <city>Anytown</city>
    <state_prov>CA</state_prov>
    <postal_code>90210</postal_code>
    <country>US</country>
    <email>john.doe@example.com</email>
    <phone>555-123-4567</phone>
  </acct_contact>

  <!-- Master Plan Instance to which the coupon is assigned -->
  <master_plan_instance_data>
    <master_plan_instance>
      <master_plan_instance_no>4000123</master_plan_instance_no>
      <client_master_plan_instance_id>MPI-10001</client_master_plan_instance_id>
      <plan_no>101</plan_no>
      <client_plan_id>PREMIUM-MONTHLY</client_plan_id>
      <plan_name>Premium Monthly Plan</plan_name>
      <plan_activation_date>2026-01-05</plan_activation_date>
      <status_cd>1</status_cd>
      <plan_units>1.00</plan_units>
      <billing_group_no>20001</billing_group_no>
      <client_billing_group_id>BG-001</client_billing_group_id>
      <promo_cd>PROMO2026</promo_cd> <!-- Coupon code reflected here as well -->
      <mpi_billing_dates>
        <bill_day>5</bill_day>
        <next_bill_date>2026-02-05</next_bill_date>
      </mpi_billing_dates>
    </master_plan_instance>
  </master_plan_instance_data>

  <!-- Coupon Details - the key section for this event -->
  <coupon_details>
    <coupon_cd>PROMO2026</coupon_cd>
    <coupon_assignment_no>60001</coupon_assignment_no>
    <!-- Assignment level codes (example values based on typical Aria usage):
         1 = Account level
         2 = Master Plan Instance level
         3 = Supplemental Plan Instance level -->
    <coupon_assignment_level>2</coupon_assignment_level>
    <master_plan_instance_no>4000123</master_plan_instance_no>
    <!-- plan_instance_no would be used if assigned to a supplemental plan -->
  </coupon_details>

  <!-- Payment method included for context (unchanged) -->
  <payment_method_data>
    <payment_method>
      <payment_method_no>30001</payment_method_no>
      <client_payment_method_id>PM-001</client_payment_method_id>
      <pay_method>1</pay_method> <!-- Credit Card -->
      <cc_suffix>1111</cc_suffix>
      <cc_exp_mm>12</cc_exp_mm>
      <cc_exp_yyyy>2028</cc_exp_yyyy>
    </payment_method>
  </payment_method_data>

  <!-- Triggering event(s) -->
  <event_data>
    <event>
      <event_id>5001</event_id>
      <event_label>Coupon Assigned</event_label>
    </event>
    <event>
      <event_id>2005</event_id>
      <event_label>Master Plan Instance Modified</event_label>
    </event>
  </event_data>
</apf2doc>

Key Notes for Developers

  1. Schema Compliance: Ensure all payloads adhere to the XSD structure, respecting required fields (e.g., version="3.8", sender="A") and optional elements (marked with minOccurs="0").
  2. Data Relationships: Elements like <billing_group_no> and <master_plan_instance_no> in <installment_data> must reference valid entities defined elsewhere in the payload.
  3. Extensibility: The XSD supports multiple occurrences of complex types (e.g., <master_plan_instance>, <event>), making it flexible for various use cases.
  4. Validation: Use an XML validator against the provided XSD to ensure correctness before processing.

These samples cover creation, modification with installments, deletion scenarios, and payment plans, providing a solid foundation for working with the Accounts and Master Plan Instances Event Class.

TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Reference
  2. Tags
    This page has no tags.