get_credit_details_m Sample Call and Response
This example retrieves the details of a specific cash credit that was previously issued on an account, based on the plsql_m_r73.yml definition file for Aria release 73.
This example includes every required field and a representative set of commonly used optional fields, not every field the method accepts. The sample response focuses on a cash credit that originated from an account-level plan downgrade and a service outage adjustment, rather than a service credit.
Sample call
{
"rest_call": "get_credit_details_m",
"output_format": "json",
"client_no": 100234,
"auth_key": "8f3d9c2e1b7a4f6d9e0c1a2b3d4e5f60",
"acct_no": 300118842,
"master_plan_instance_no": 550219,
"credit_no": 88231
}
The rest_call and output_format fields are envelope fields added by the REST layer; they are not part of the method's own documented arguments. For the account identifier, this example uses acct_no rather than its alternative, client_acct_id. For the master subscription plan instance identifier, this example uses master_plan_instance_no rather than its alternative, client_master_plan_instance_id. The credit_no field is required and identifies the specific credit whose details you want to retrieve. The locale_no and locale_name fields, which control the language of the returned text, are left out of this example.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"created_by": "csr_agarcia",
"created_date": "2026-06-02 09:14:22",
"amount": 45.00,
"credit_type": "cash",
"applied_amount": 30.00,
"unapplied_amount": 15.00,
"reason_code": 205,
"reason_text": "Service outage credit",
"comments": "Applied per customer service ticket 88213 for downtime on 2026-05-28.",
"transaction_id": 9042117,
"credit_expiry_type_ind": "M",
"credit_expiry_months": 12,
"out_client_mp_instance_id": "MPI-ACME-0447",
"acct_locale_name": "English (United States)",
"out_acct_no_2": 300118842,
"out_master_plan_instance_no_2": 550219,
"eligible_service_types": [
{
"eligible_service_types": "RC"
},
{
"eligible_service_types": "US"
}
],
"cash_cr_origin": [
{
"origin_master_plan_instance_no": 550219,
"origin_client_mp_instance_id": "MPI-ACME-0447",
"origin_plan_instance_no": 771034,
"origin_client_plan_instance_id": "PI-ACME-VOICE-01",
"origin_plan_name": "Business Voice Unlimited",
"origin_proration_remaining_days": "6",
"origin_adv_billing_period_total_days": "30",
"origin_invoice_no": 8820441,
"origin_service_no": 41200,
"origin_service_name": "Voice Service",
"origin_client_service_id": "SVC-VOICE-01",
"origin_plan_action_details": "Plan downgraded from Business Voice Unlimited to Business Voice Basic"
},
{
"origin_master_plan_instance_no": 550219,
"origin_client_mp_instance_id": "MPI-ACME-0447",
"origin_plan_instance_no": 771035,
"origin_client_plan_instance_id": "PI-ACME-DATA-01",
"origin_plan_name": "Business Data 500GB",
"origin_proration_remaining_days": "2",
"origin_adv_billing_period_total_days": "30",
"origin_invoice_no": 8820441,
"origin_service_no": 41205,
"origin_service_name": "Data Service",
"origin_client_service_id": "SVC-DATA-01",
"origin_plan_action_details": "Service outage credit issued for scheduled maintenance downtime"
}
]
}
An error_code value of 0 and an error_msg value of “OK” indicate the call succeeded. The credit_expiry_type_ind value of “M” indicates the credit expires based on a number of months rather than weeks, a specific date, or days; the other allowable values are “W” for weeks, “Y” for days, and “D” for a specific date. The eligible_service_types array would list every service type code eligible to apply this credit if more than two applied; this example shows two of the ten possible codes, RC for Recurring Service and US for Usage Service. The cash_cr_origin array would contain one entry for every plan instance or invoice line that contributed to the origin of this cash credit; this example shows two entries. This example leaves out the deprecated out_acct_no, out_master_plan_instance_no, and acct_locale_no fields, as well as the eligible_service_plan_details and eligible_plan_instance_details arrays, and the credit_expiry_date and credit_expiry_period fields, all of which are optional and not needed to tell this credit's story. The nonpublic error_details field is also left out.