get_recurring_credit_info_m Sample Call and Response
This example retrieves the recurring credits associated with a specific master plan instance on an account, based on the plsql_m_r73.yml definition file for release seventy-three.
This example includes every required field and a representative set of commonly used optional fields, not every field the method accepts.
Sample call
{
"rest_call": "get_recurring_credit_info_m",
"output_format": "json",
"client_no": 92310,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"acct_no": 300587421,
"master_plan_instance_no": 552091
}
The rest_call and output_format fields form the envelope that the REST layer adds to every call; neither field appears in the method's own documented arguments. The acct_no field is one side of an alternative-field pair with client_acct_id; this example uses the Aria-assigned acct_no. The master_plan_instance_no field is likewise one side of an alternative-field pair with client_master_plan_instance_id, and narrows the results to the recurring credits tied to one master plan instance rather than every recurring credit on the account. This example leaves out the optional filter_credit_no field, which would further narrow the results to a single recurring credit by its identifier, and the optional locale_no and locale_name alternative-field pair, which selects a translation locale for the returned text.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"recurring_credits_details": [
{
"recurring_credit_no_2": 88213,
"out_acct_no_2": 300587421,
"out_master_plan_instance_no": 552091,
"create_date": "2026-01-15 09:22:00",
"create_user": "svc_billing_admin",
"first_credit_date": "2026-02-01",
"last_credit_date": "2026-07-01",
"next_credit_date": "2026-08-01",
"credit_amount": 5.00,
"currency_cd": "usd",
"credits_completed": 6,
"credits_remaining": 6,
"credit_interval_months": 1,
"credit_interval_type_ind": "M",
"service_no_to_apply": 41207,
"service_name_to_apply": "Premium Streaming Service",
"credit_status_cd": 1,
"credit_status_label": "Active",
"credit_reason_cd": 2,
"credit_reason_text": "Inadequate Service Delivery",
"comments": "Monthly service credit issued for a service outage in January 2026."
},
{
"recurring_credit_no_2": 88214,
"out_acct_no_2": 300587421,
"out_master_plan_instance_no": 552091,
"create_date": "2026-03-10 14:05:00",
"create_user": "jharmon",
"first_credit_date": "2026-04-01",
"last_credit_date": "2026-09-01",
"next_credit_date": "2026-08-01",
"credit_amount": 2.50,
"currency_cd": "usd",
"credits_completed": 4,
"credits_remaining": 2,
"credit_interval_months": 1,
"credit_interval_type_ind": "M",
"service_no_to_apply": 41209,
"service_name_to_apply": "Standard Support Plan",
"credit_status_cd": 1,
"credit_status_label": "Active",
"credit_reason_cd": 32,
"credit_reason_text": "Refer-a-Friend",
"comments": "Referral incentive credit."
}
]
}
An error_code value of zero and an error_msg value of “OK” indicate that the call succeeded. The recurring_credits_details array holds one entry per recurring credit found; this example shows two representative entries, and a real account could return more or fewer. The credit_reason_cd field uses an enumerated legend of reason codes; this example uses value 2, meaning “Inadequate Service Delivery,” and value 32, meaning “Refer-a-Friend,” though many other reason codes exist. The credit_interval_type_ind field uses value “M,” meaning the interval between credits is measured in months, as opposed to “W” for weeks or “D” for days. This example omits the out_acct_no and recurring_credit_no fields, which carry a deprecate_version of nineteen, in favor of their non-deprecated replacements, out_acct_no_2 and recurring_credit_no_2. It also omits eligible_plan_no, eligible_plan_name, eligible_service_no, eligible_service_name, client_eligible_plan_id, and client_eligible_service_id, all of which carry a deprecate_version of twenty, as well as the cancel_date, cancel_user, and cancel_comments fields, since neither example credit has been cancelled. The eligible_service_types array, the eligible_service_plan_details field, and the eligible_plan_instance_details field are left out for simplicity, as are the acct_locale_no and acct_locale_name fields that the method can also return. The error_details field is left out because it is marked nonpublic in the shared param_defaults block.