Data Feed 67 Release
- Discount Rule Bundle (EXTRACT-49, EXTRACT-109, EXTRACT-2649, EXTRACT-2650, EXTRACT-2652, EXTRACT-2653, EXTRACT-4132)
- Installment Tax Application - Surcharge (EXTRACT-11220)
- Installment - Adding side effect for Statement LOM (EXTRACT-11387, EXTRACT-11600)
- Plan Rate Schedule Rate Version (EXTRACT-11405, EXTRACT-11406, EXTRACT-11407, EXTRACT-11408)
- Advanced Usage Pricing - Plan level indicator [Allegro feature] (DEV-12197, DEV-12177) (EXTRACT-11724)
- Update Plan Rate Schedule LOM (DEV-12198, DEV-12177) (EXTRACT-11725)
- Adding Plan no field in plan rate schedule LOM (EXTRACT-11805)
Discount Rule Bundle (EXTRACT-49, EXTRACT-109, EXTRACT-2649, EXTRACT-2650, EXTRACT-2652, EXTRACT-2653, EXTRACT-4132)
(Data Feed, Universal Connector)
To support the discount rule bundle data in Aria Billing, a new LOM called Discount Rule Bundle has been introduced in Data Feed. For the discount rule bundle, you can both Create and Delete events. An Update event is not currently supported, however may be included in a future release. The Discount Rule Bundle is found in a subscription under the Product Catalog objects. Within catalog objects, we have the ability to init load the Discount Rule Bundle.
Sample Discount Rule Bundle Payload
{"bundle_no":2359,"client_bundle_id":"Discount_Bundle","name":"Discount Bundle","description":"Discount_Bundle","is_overlap_allowed":true,"rule_ordering":[{"primacy":1,"discount_rule":{"ids":{"discount_rule_no":13385,"client_discount_rule_id":"QA_Discount_Rule_ID_61874805929736fk0OrigIN9VnlLYoFUL6"},"type":"Discount_Rule"}},{"primacy":2,"discount_rule":{"ids":{"discount_rule_no":13386,"client_discount_rule_id":"QA_Discount_Rule_ID_61879596326339HVMjcaUVWfx8zsMrQ5Uh"},"type":"Discount_Rule"}},{"primacy":3,"discount_rule":{"ids":{"discount_rule_no":13388,"client_discount_rule_id":"QA_Discount_Rule_ID_61891361989714U3aczwcOCtbjb9fRXCyP"},"type":"Discount_Rule"}}],"created_tstamp":"2025-09-05T02:11:42+02:00"}
Installment Tax Application - Surcharge (EXTRACT-11220)
(Data Feed, Universal Connector)
Support has been added for the application of Surcharges for Installment Taxes. When the tax line for a Surcharge is paid, the Installment Tax application payload is now received.
Installment - Adding side effect for Statement LOM (EXTRACT-11387, EXTRACT-11600)
(Data Feed, Universal Connector)
A new <statement_number> element has been added to the Installment LOM. As a byproduct of creating a Statement LOM, the Installment Statement update payload is created when a Statement is generated.
The Sample Statement Installment Payload
{"client_no":7000209,"ref":{"ids":{"installment_no":12281,"seq_no":1},"type":"Installment"},"data":{"installment_no":12281,"seq_no":1,"statement":{"ids":{"statement_no":6529465},"type":"Statement"},"updated_tstamp":"2025-09-24T21:02:26+02:00"}
Plan Rate Schedule Rate Version (EXTRACT-11405, EXTRACT-11406, EXTRACT-11407, EXTRACT-11408)
(Data Feed, Universal Connector)
In the Plan Rate Schedule LOM, support has been added to accommodate versioning of the Plan Rate Schedule. An extra array called <versions> contains all of the version-related information. The Subscription and Init Load dashboard pages remain unchanged by the addition because <versions> is only a component of the Plan Rate Schedule LOM.
{"schedule_no":57894,"client_rate_schedule_id":"Plan_Allegro_67_Rate","name":"Plan_Allegro_67_Rate","currency":{"ids":{"currency_cd":"usd","code":"usd"},"type":"Currency"},"available_from_date":"2025-09-04","available_to_date":null,"recurring_billing_interval":{"interval_type":{"ids":{"type_no":3},"type":"Billing_Interval_Type"},"value":1},"usage_billing_interval":{"interval_type":{"ids":{"type_no":3},"type":"Billing_Interval_Type"},"value":1},"followup_default_rate_schedule":null,"created_tstamp":"2025-09-04T20:03:29+02:00","is_default_for_currency":true,"tiers":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":23,"queued_rate_per_unit":45,"locale_details":[{"locale":{"ids":{"locale_no":10001},"type":"Locale"},"description":null}]},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":12,"queued_rate_per_unit":9,"locale_details":[{"locale":{"ids":{"locale_no":10001},"type":"Locale"},"description":null}]}],"queued_rate_change_date":"2025-09-30","locale_details":[{"locale":{"ids":{"locale_no":10001},"type":"Locale"},"name":"Plan_Allegro_67_Rate"}],"versions":[{"version_no":55651,"available_from_date":"2025-09-04","available_to_date":"2025-09-30","tiers":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":23},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":12}]},{"version_no":55652,"available_from_date":"2025-09-30","available_to_date":"3000-12-31","tiers":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":45},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":9}]}],"service_details":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"has_advanced_usage_allowance":false,"has_advanced_usage_accumulator":true},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"has_advanced_usage_allowance":true,"has_advanced_usage_accumulator":false}],"plan":{"ids":{"plan_no":32355,"client_plan_id":"Plan_Allegro_67"},"type":"Plan"}}
To facilitate versioning, the <plan_rate_schedule_version> element has been included in the Transaction and Pending Invoice Line LOM.
The <plan_rate_schedule_version> element looks as follows:
"plan_rate_schedule_version":19435
Complete Transaction LOM
{"transaction_no":5062331,"transaction_type":{"ids":{"type_no":21,"enum":21},"type":"Transaction_Type"},"created_tstamp":"2025-09-04T21:54:25+02:00","source_no":6126062,"account":{"ids":{"account_no":299387,"userid":"rrm8c9wm","client_account_id":"epTYoI8IExEKgiE2QXqPFTGlFx7Y9O7ru3iXoFzK0ckutRrdMQ"},"type":"Account"},"currency":{"ids":{"currency_cd":"usd","code":"usd"},"type":"Currency"},"amount":10,"applied_amount":0,"fully_applied_tstamp":null,"statement":{"ids":{"statement_no":6530158},"type":"Statement"},"master_plan_instance":{"ids":{"plan_instance_no":601036,"client_plan_instance_id":"Updated_PID_80279076377904"},"type":"Plan_Instance"},"api_receipt_id":null,"transaction_supp_fields":[],"voided_transaction":null,"voiding_transaction":null,"invoice":{"ids":{"invoice_no":1314420},"type":"Invoice"},"line_no":2,"plan":{"ids":{"plan_no":18585,"client_plan_id":"Extract_clientPlanId_1610972433587"},"type":"Plan"},"plan_instance":{"ids":{"plan_instance_no":601036,"client_plan_instance_id":"Updated_PID_80279076377904"},"type":"Plan_Instance"},"service":{"ids":{"service_no":11054919,"client_service_id":"11054919"},"type":"Service"},"usage_type":null,"order_line":null,"plan_rate_schedule":{"ids":{"schedule_no":32280,"client_rate_schedule_id":"Plan_Sched_Id_1610972433586"},"type":"Plan_Rate_Schedule"},"plan_rate_schedule_service_tier":1,"service_credit":null,"service_credit_source_transaction":null,"service_credit_target_transaction":null,"credit_coupon":null,"credit_reason":null,"purchase_order_number":null,"start_date":"2025-09-04","end_date":"2025-10-03","rate":10,"units":1,"base_plan_units":1,"prompt_payment_discount_amount":null,"prompt_payment_discount_cutoff_date":null,"proration_factor":1,"proration_description":"30 of 30 days","proration_remaining_days":30,"advance_billing_period_total_days":30,"is_tax_related":false,"comments":"Extract_Recurring1610972433586","surcharge_rate_schedule":null,"surcharge_rate_schedule_tier":null,"proration_operation_type":{"ids":{"type_no":31},"type":"Proration_Operation_Type"},"nonsubscription_offering_rate_schedule":null,"nonsubscription_offering_rate_schedule_tier":null,"is_custom_rated":false,"pre_discount_amount":null,"installment_term":null,"plan_rate_schedule_version":19435}
Complete Pending Invoice Line LOM
{"invoice":{"ids":{"invoice_no":1314384},"type":"Invoice"},"line_no":2,"plan":{"ids":{"plan_no":18585,"client_plan_id":"Extract_clientPlanId_1610972433587"},"type":"Plan"},"plan_instance":{"ids":{"plan_instance_no":601009,"client_plan_instance_id":"601009"},"type":"Plan_Instance"},"service":{"ids":{"service_no":11054919,"client_service_id":"11054919"},"type":"Service"},"service_credit":null,"service_credit_source_transaction":null,"plan_rate_schedule":{"ids":{"schedule_no":32280,"client_rate_schedule_id":"Plan_Sched_Id_1610972433586"},"type":"Plan_Rate_Schedule"},"usage_type":null,"order_line":null,"credit_coupon":null,"purchase_order_number":null,"start_date":"2025-09-04","end_date":"2025-10-03","advance_billing_period_total_days":null,"plan_rate_schedule_service_tier":1,"units":1,"rate":10,"base_plan_units":1,"proration_factor":1,"proration_description":null,"proration_remaining_days":null,"credit_reason":null,"is_tax_related":false,"comments":"Extract_Recurring1610972433586","surcharge_rate_schedule":null,"surcharge_rate_schedule_tier":null,"proration_operation_type":null,"nonsubscription_offering_rate_schedule":null,"nonsubscription_offering_rate_schedule_tier":null,"is_custom_rated":false,"pre_discount_amount":null,"installment_term":null,"plan_rate_schedule_version":19435}
Advanced Usage Pricing - Plan level indicator [Allegro feature] (DEV-12197, DEV-12177) (EXTRACT-11724)
(Data Feed, Universal Connector)
A new boolean element called <use_advanced_usage_pricing> has been added to the Plan LOM to support the Advanced Usage Pricing feature in Allegro.
Sample Payload
{"plan_no":32355,"client_plan_id":"Plan_Allegro_67","name":"Plan_Allegro_67","description":null,"is_active":true,"is_supplemental_plan":false,"is_template":false,"product_field_categories":[],"proration_invoice_timing_cd":{"ids":{"option_no":0,"enum":0},"type":"Proration_Invoice_Timing_Option"},"statement_template":{"ids":{"template_no":10039626,"client_template_id":"_10039626"},"type":"Email_Template"},"notification_template_group":null,"credit_note_template":null,"credit_memo_template":null,"rebill_template":null,"has_plan_cancellation_fee":false,"cancellation_minimum_months":null,"surcharges":[],"service_details":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"tiered_pricing_rule":{"ids":{"rule_no":1},"type":"Tiered_Pricing_Rule"},"is_high_water":false,"has_usage_tier_multiplier":false,"pool_child_billable_unit_thresholds":false,"billable_unit_usage_threshold":null,"usage_thresholds":[],"is_tax_inclusive":false,"avalanche_earn_on_cancel":false,"is_fulfillment_based":false,"has_single_line_proration":false,"usage_rating_time_indicator":null,"usage_record_rating_level_indicator":null},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"tiered_pricing_rule":{"ids":{"rule_no":1},"type":"Tiered_Pricing_Rule"},"is_high_water":false,"has_usage_tier_multiplier":false,"pool_child_billable_unit_thresholds":false,"billable_unit_usage_threshold":null,"usage_thresholds":[],"is_tax_inclusive":false,"avalanche_earn_on_cancel":false,"is_fulfillment_based":false,"has_single_line_proration":false,"usage_rating_time_indicator":null,"usage_record_rating_level_indicator":null},{"service":{"ids":{"service_no":11071320,"client_service_id":"11071320"},"type":"Service"},"tiered_pricing_rule":{"ids":{"rule_no":1},"type":"Tiered_Pricing_Rule"},"is_high_water":false,"has_usage_tier_multiplier":false,"pool_child_billable_unit_thresholds":false,"billable_unit_usage_threshold":null,"usage_thresholds":[],"is_tax_inclusive":false,"avalanche_earn_on_cancel":false,"is_fulfillment_based":false,"has_single_line_proration":false,"usage_rating_time_indicator":0,"usage_record_rating_level_indicator":0}],"rate_schedules":[{"ids":{"schedule_no":57894,"client_rate_schedule_id":"Plan_Allegro_67_Rate"},"type":"Plan_Rate_Schedule"}],"nonsubscription_offering_bundle_type":{"ids":{"item_type_code":"I"},"type":"NonSubscription_Offering_Bundle_Type"},"nonsubscription_offering_individuals":[],"nonsubscription_offering_group":null,"available_nonsubscription_offering_scope":{"ids":{"item_inclusion_type_ind":0},"type":"Available_NonSubscription_Offering_Scope"},"available_nonsubscription_offerings":[],"default_currency":{"ids":{"currency_cd":"usd","code":"usd"},"type":"Currency"},"initial_free_period_quantity":null,"initial_free_period_type":{"ids":{"interval_type_no":1},"type":"Rollover_Interval_Type"},"initial_plan_instance_status":{"ids":{"status_no":1,"enum":1},"type":"Plan_Instance_Status"},"plan_instance_status_rollover_period_quantity":null,"plan_instance_status_rollover_period_type":{"ids":{"interval_type_no":1},"type":"Rollover_Interval_Type"},"rollover_plan_instance_status":{"ids":{"status_no":1,"enum":1},"type":"Plan_Instance_Status"},"rollover_plan":null,"rollover_plan_period_quantity":null,"rollover_plan_period_type":{"ids":{"interval_type_no":1},"type":"Rollover_Interval_Type"},"contract_completion_rollover_plan":null,"contract_completion_rollover_rate_schedules":[],"locale_details":[{"locale":{"ids":{"locale_no":10001},"type":"Locale"},"name":"Plan_Allegro_67","description":null}],"product_field_assignments":[],"created_tstamp":"2025-09-04T20:03:29+02:00","use_advanced_usage_pricing":true
Update Plan Rate Schedule LOM (DEV-12198, DEV-12177) (EXTRACT-11725)
(Data Feed, Universal Connector)
A new <service_details> element has been added to the Plan Rate Schedule LOM. This element includes service related information inside the parameters of the schedule. The service related information has been added at the top level of the Plan Rate Schedule LOM.
The services are assigned values in the LOM structure, however this structure will not include services that are not assigned.
Sample Payload
{"schedule_no":57894,"client_rate_schedule_id":"Plan_Allegro_67_Rate","name":"Plan_Allegro_67_Rate","currency":{"ids":{"currency_cd":"usd","code":"usd"},"type":"Currency"},"available_from_date":"2025-09-04","available_to_date":null,"recurring_billing_interval":{"interval_type":{"ids":{"type_no":3},"type":"Billing_Interval_Type"},"value":1},"usage_billing_interval":{"interval_type":{"ids":{"type_no":3},"type":"Billing_Interval_Type"},"value":1},"followup_default_rate_schedule":null,"created_tstamp":"2025-09-04T20:03:29+02:00","is_default_for_currency":true,"tiers":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":23,"queued_rate_per_unit":null,"locale_details":[{"locale":{"ids":{"locale_no":10001},"type":"Locale"},"description":null}]},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":12,"queued_rate_per_unit":null,"locale_details":[{"locale":{"ids":{"locale_no":10001},"type":"Locale"},"description":null}]}],"queued_rate_change_date":null,"locale_details":[{"locale":{"ids":{"locale_no":10001},"type":"Locale"},"name":"Plan_Allegro_67_Rate"}],"versions":[{"version_no":55651,"available_from_date":"2025-09-04","available_to_date":"3000-12-31","tiers":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":23},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"tier":1,"description":null,"unit_upper_limit":null,"rate_per_unit":12}]}],"service_details":[{"service":{"ids":{"service_no":11000049,"client_service_id":"VR_Recurring_1"},"type":"Service"},"has_advanced_usage_allowance":false,"has_advanced_usage_accumulator":true},{"service":{"ids":{"service_no":11031685,"client_service_id":"Trans_check_Service"},"type":"Service"},"has_advanced_usage_allowance":true,"has_advanced_usage_accumulator":false}],"plan":{"ids":{"plan_no":32355,"client_plan_id":"Plan_Allegro_67"},"type":"Plan"}
Adding Plan no field in plan rate schedule LOM (EXTRACT-11805)
(Data Feed, Universal Connector)
A new field called <plan_no> has been added in the Plan Rate Schedule LOM.
"plan":{"ids":{"plan_no":32355,"client_plan_id":"Plan_Allegro_67"},"type":"Plan"}
Object Subscription Page in Release 67