Aria Billing Cloud API
Take me to SwaggerHub: |
Table of Contents
API Topics
- Aria API Concepts
- Learn prerequisites for working with Aria's API, including how to format API calls and test use cases before starting to code.
- Aria Core API
- The Core API category comprises API calls that are generally used to work with accounts, account transactions, configuration, and billing interactions.
- Account Communication Creation
- Account Communication Retrieval
- Account Creation
- Account Data Retrieval
- Account Modification
- Account Transaction Creation
- Account Transaction Modification
- Account Transaction Retrieval
- Account Unbilled Usage Summary Information
- Implementation Configuration Modification
- Implementation Configuration Retrieval
- Other and Special
- Aria Object Query API
- The Object Query API category comprises API calls that are used to query and get multi-row feedback across accounts, or to extract client product catalog or marketing information.
- get_account_details_m Guide
- get_account_plan_history_m Guide
- get_account_status_history_m Guide
- get_all_invoice_information_m Guide
- get_coupon_history_m Guide
- get_invoice_information_m Guide
- get_invoice_summary_m Guide
- get_order_details_m Guide
- get_payment_details_m Guide
- get_plan_instance_information_m Guide
- get_refund_information_m Guide
- get_transaction_information_m Guide
- get_usage_history_information_m Guide
- list_payment_methods_m Guide
- list_payment_processors_m Guide
- list_transaction_types_m Guide
- Aria Admintools API
- The Admintools API category comprises API calls that deal with managing a client's product catalog and marketing activities including the ability to create, modify, and delete objects.
- add_coa_m
- add_coa_m Guide
- add_rate_schedule_on_plan_m
- add_rate_schedule_on_plan_m Guide
- copy_plan_m
- copy_plan_m Guide
- create_channel_m (DEPRECATED)
- create_channel_m Guide (DEPRECATED)
- create_coupon_group_m
- create_coupon_group_m Guide
- create_coupon_m
- create_coupon_m Guide
- create_credit_template_m
- create_credit_template_m Guide
- create_discount_bundle_m
- create_discount_bundle_m Guide
- create_discount_rule_m
- create_discount_rule_m Guide
- create_installment_term_m
- create_installment_term_m Guide
- create_inventory_item_m
- create_inventory_item_m Guide
- create_item_class_m
- create_item_class_m Guide
- create_legal_entity_m
- create_legal_entity_m Guide
- create_new_plan_m
- create_new_plan_m Guide
- create_payment_terms_m
- create_payment_terms_m Guide
- create_plan_group_m
- create_plan_group_m Guide
- create_product_field_category_m
- create_product_field_category_m Guide
- create_promotion_m
- create_promotion_m Guide
- create_promo_plan_set_m
- create_promo_plan_set_m Guide
- create_reason_code_m
- create_reason_code_m Guide
- create_revrec_profile_m
- create_revrec_profile_m Guide
- create_service_location_m
- create_service_location_m Guide
- create_service_m
- create_service_m Guide
- create_supp_field_m
- create_supp_field_m Guide
- create_supp_obj_field_m
- create_supp_obj_field_m Guide
- create_supp_usage_fields_m
- create_supp_usage_fields_m Guide
- create_surcharge_m
- create_surcharge_m Guide
- create_usage_type_m
- create_usage_type_m Guide
- delete_bundles_m
- delete_bundles_m Guide
- delete_coupons_m
- delete_coupons_m Guide
- delete_coupon_group_m
- delete_coupon_group_m Guide
- delete_legal_entity_m
- delete_legal_entity_m Guide
- delete_payment_terms_m
- delete_payment_terms_m Guide
- delete_plans_m
- delete_plans_m Guide
- delete_plan_group_m
- delete_plan_group_m Guide
- delete_product_field_category_m
- delete_product_field_category_m Guide
- delete_revrec_profile_m
- delete_revrec_profile_m Guide
- delete_rules_m
- delete_rules_m Guide
- delete_surcharge_m
- delete_surcharge_m Guide
- delete_templates_m
- delete_templates_m Guide
- edit_coa_m
- edit_coa_m Guide
- edit_installment_terms_m
- edit installment terms m Guide
- edit_item_class_m
- edit_item_class_m Guide
- edit_plan_m
- edit_plan_m Guide
- edit_product_field_category_m
- edit_product_field_category_m Guide
- edit_rate_schedule_on_plan_m
- edit_rate_schedule_on_plan_m Guide
- edit_surcharge_m
- edit_surcharge_m Guide
- get_all_reason_codes_m
- get_all_reason_codes_m Guide
- get_client_payment_method_m
- get_client_payment_method_m Guide
- get_coa_m
- get_coa_m Guide
- get_company_profile_m
- get_company_profile_m Guide
- get_coupons_m
- get_coupons_m Guide
- get_coupon_details_m
- get_coupon_details_m Guide
- get_coupon_groups_m
- get_coupon_groups_m Guide
- get_coupon_group_details_m
- get_coupon_group_details_m Guide
- get_discount_bundles_m
- get_discount_bundles_m Guide
- get_discount_bundle_details_m
- get_discount_bundle_details_m Guide
- get_discount_rules_m
- get_discount_rules_m Guide
- get_discount_rule_details_m
- get_discount_rule_details_m Guide
- get_dunning_processes_m
- get_dunning_processes_m Guide
- get_gl_code_info_m
- get_gl_code_info_m Guide
- get_installment_terms_m
- get_installment_terms_m Guide
- get_inventory_items_m
- get_inventory_items_m Guide
- get_inventory_item_details_m
- get_inventory_item_details_m Guide
- get_legal_entity_m
- get_legal_entity_m Guide
- get_payment_terms_m
- get_payment_terms_m Guide
- get_plans_m
- get_plans_m Guide
- get_plan_details_m
- get_plan_details_m Guide
- get_plan_groups_m
- get_plan_groups_m Guide
- get_plan_group_details_m
- get_plan_group_details_m Guide
- get_plan_service_details_m
- get_plan_service_details_m Guide
- get_product_field_categories_m
- get_product_field_categories_m Guide
- get_product_field_category_details_m
- get_product_field_category_details_m Guide
- get_promotions_m
- get_promotions_m Guide
- get_promotion_details_m
- get_promotion_details_m Guide
- get_promo_plan_sets_m
- get_promo_plan_sets_m Guide
- get_promo_plan_set_details_m
- get_promo_plan_set_details_m Guide
- get_reason_code_m
- get_reason_code_m Guide
- get_recurring_credit_templates_m
- get_recurring_credit_templates_m Guide
- get_recurring_credit_template_details_m
- get_recurring_credit_template_details_m Guide
- get_revrec_profiles_m
- get_revrec_profiles_m Guide
- get_revrec_profile_details_m
- get_revrec_profile_details_m Guide
- get_services_m
- get_services_m Guide
- get_service_details_m
- get_service_details_m Guide
- get_service_types_m
- get_service_types_m Guide
- get_supp_fields_m
- get_supp_fields_m Guide
- get_supp_field_details_m
- get_supp_field_details_m Guide
- get_supp_obj_fields_m
- get_supp_obj_fields_m Guide
- get_supp_usage_fields_m
- get_supp_usage_fields_m Guide
- get_surcharges_m
- get_surcharges_m Guide
- get_surcharge_details_m
- get_surcharge_details_m Guide
- get_usage_types_m
- get_usage_types_m Guide
- get_usage_type_details_m
- get usage type details m Guide
- get_usage_unit_types_m
- get_usage_unit_types_m Guide
- list_coa_m
- list_coa_m Guide
- list_promo_sets_m
- list_promo_sets_m Guide
- list_supp_obj_fields_m
- list_supp_obj_fields_m Guide
- list_supp_usage_fields_m
- list_supp_usage_fields_m Guide
- remove_gl_code_m
- remove_gl_code_m Guide
- set_company_profile_m
- set_company_profile_m Guide
- set_gl_code_m
- set_gl_code_m Guide
- update_coupon_group_m
- update_coupon_group_m Guide
- update_coupon_m
- update_coupon_m Guide
- update_credit_template_m
- update_credit_template_m Guide
- update_inventory_item_m
- update_inventory_item_m Guide
- update_legal_entity_m
- update_legal_entity_m Guide
- update_plan_group_m
- update_plan_group_m Guide
- update_promotion_m
- update_promotion_m Guide
- update_promo_plan_set_m
- update_promo_plan_set_m Guide
- update_reason_code_m
- update_reason_code_m Guide
- update_revrec_profile_m
- update_revrec_profile_m Guide
- update_service_location_status_m
- update_service_location_status_m Guide
- update_service_m
- update_service_m Guide
- update_supp_field_m
- update_supp_field_m Guide
- update_supp_obj_field_m
- update_supp_obj_field_m Guide
- update_usage_type_m
- update_usage_type_m Guide
- validate_admin_session_m
- validate_admin_session_m Guide
- Aria Access Management API
- The Core API category comprises API calls to administer users of Aria who will log in to Aria and work with accounts, account transactions, configuration, and billing interactions.
- Aria TM-Forum API
- The TM Forum Open API & ODA model is designed to replace traditional operational and business support systems (OSS/BSS) architectures and become the de facto standard for open platforms, allowing communication service providers (CSPs) to digitally transform and reduce software procurement, integration, and development inefficiencies.
About API Categories
Core API
The Core API category comprises API calls that are generally used to work with accounts, account transactions, configuration, and billing interactions.
The supported formats for calling the Core APIs are:
- REST (application/json);
- REST (application/x-www-form-urlencoded); and
- SOAP.
Guides for Core API calls include links to specifications formatted on SwaggerHub.
Object Query API
The Object Query API category comprises API calls that are used to query and get multi-row feedback across accounts, or to extract client product catalog or marketing information.
The supported formats for calling the Object Query APIs are:
- application/x-www-form-urlencoded; and
- SOAP.
Guides for Object Query API calls include links to specifications formatted on SwaggerHub.
Admintools API
The Admintools API category comprises API calls that deal with managing a client's product catalog and marketing activities including the ability to create, modify, and delete objects.
The supported format for calling the Admintools APIs is application/x-www-form-urlencoded.
Access Management API
The "Access Management API" category comrprises API calls that deal with managing users in your Aria instance, including the ability to create, modify, and delete users. The supported format for calling the User Access APIs is REST (application/json).
TM Forum Open API
The TM Forum Open API & ODA model is designed to replace traditional operational and business support systems (OSS/BSS) architectures and become the de facto standard for open platforms, allowing communication service providers (CSPs) to digitally transform and reduce software procurement, integration, and development inefficiencies. The supported format for calling the TM Forum Open APIs is REST (application/json). Learn more about Aria's TM Forum Open API initiative.
Note: For SOAP and REST calls, the POST method is supported. The GET method is not supported.