Skip to main content
Aria Knowledge Central

get_recurring_credit_info_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_recurring_credit_info_m
Class account_services_m
Update Version 23

Description

This API returns a list of recurring credits associated with a specified account or master plan instance.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
master_plan_instance_no long 22 No

The Master Subscription plan instance number.

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_no
filter_credit_no long 22 No

The recurring credit number to use in order to filter results.
locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
recurring_credits_details object   No

See fields below
acct_locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string 100 No

Name of the account level locale.

recurring_credits_details.eligible_service_types fields

Name Type Length Required Description
eligible_service_types string 2 No

Service type code for which the credit is applicable.

Allowed values:

Value Description
RC Recurring Service
US Usage Service
TX Tax Service
AC Activation Service
MS Miscellaneous Service
CN Cancellation Service
OR Order Based Service
MN Minimum Fee Service

recurring_credits_details.eligible_service_plan_details fields

Name Type Length Required Description
plan_no long 22 No

The plan numbers that is eligible to apply this credit.
plan_name string 100 No

The name of the eligible plan.
service_no long 22 No

The service number associated with the plan that is eligible to apply this credit
service_name string 100 No

The name of the eligible service.
client_plan_id string 100 No

The client defined plan identifier.
client_service_id string 100 No

The client defined identifier for the service associated with this plan

recurring_credits_details.eligible_plan_instance_details fields

Name Type Length Required Description
plan_instance_no long 22 No

The plan instance number that is eligible to apply this credit.
client_plan_instance_id string 100 No

The client defined plan instance identifier.
plan_instance_service_no long 22 No

The service number associated with the plan instance that is eligible to apply this credit.
client_plan_instance_service_id string 100 No

The client defined identifier for the service associated with this plan instance.

recurring_credits_details fields

Name Type Length Required Description
out_acct_no long 22 No

Note: This field is deprecated. Aria no longer supports out_acct_no.
out_master_plan_instance_no long 22 No

The Master Subscription plan instance number.
out_client_mp_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.
recurring_credit_no long   No

Note: This field is deprecated. Aria no longer supports recurring_credit_no.
create_date string   No

The date the recurring credit record was created.
create_user string   No

The user who created the recurring credit record.
update_date string   No

The date the recurring credit record was last updated.
update_user string   No

The user who last updated the recurring credit record
first_credit_date string   No

The first date that recurring credit was applied to the account.
last_credit_date string   No

The last date that recurring credit will be applied to the account.
next_credit_date string   No

The next date that a recurring credit will be applied to the account (assuming the last_credit_date has not passed)
credit_amount double   No

The monetary amount of the credit to be applied for each iteration of the recurring credit sequence.
currency_cd string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
credits_completed long   No

The number of credits that have been applied to the account
credits_remaining long   No

The number of remaining credits to apply to the account
credit_interval_months long   No

The interval (in months) between credits to the account
credit_interval_weeks long   No

The interval (in weeks) between credits to the account
credit_interval_days long   No

The interval (in days) between credits to the account
credit_interval_type_ind string 1 No

The type of the interval between credits to the account(months, weeks, or days)

Allowed values:

Value Description
M Interval in Months
W Interval in Weeks
D Interval in Days
eligible_plan_no long   No

Note: This field is deprecated. Aria no longer supports eligible_plan_no.
eligible_plan_name string   No

Note: This field is deprecated. Aria no longer supports eligible_plan_name.
eligible_service_no long   No

Note: This field is deprecated. Aria no longer supports eligible_service_no.
eligible_service_name string   No

Note: This field is deprecated. Aria no longer supports eligible_service_name.
service_no_to_apply long   No

The service number to apply the recurring credit to.
service_name_to_apply string   No

The name of the service to apply the recurring credit to.
credit_status_cd long   No

The status code for the recurring credit.
credit_status_label string   No

The label for the recurring credit status code.
credit_reason_cd long   No

The reason code for the application of credit toward the account specified

Allowed values:

Value Description
1 General Credit/Other
2 Inadequate Service Delivery
3 Billing / Pricing Issue
4 Service no longer desired
5 Customer Dissatisfaction
6 Installation Issue
9 Customer Return
11 System Testing
12 Prepay Code Redemption
21 Billing Issue
22 Demo/Partner Account
23 Duplicate Charge
24 Employee Account
25 Pricing Issue
26 Return (RMA) Broken
27 Return (RMA) Cancel
28 Return (RMA) Wrong Product
29 Service Issue
30 Shipping Credit
31 Test Account
32 Refer-a-Friend
95 Client-defined automatic "form of payment discount"
96 Order Item Unit Credit
97 New Service Plan Proration
98 Prepay Credit Reconciliation
99 Balance Forward Conversion
1004 Pricing
1005 Service Error
1006 Hardware Malfunction
1007 Goodwill
1008 Billing Error
1009 Development
1010 Shipping Error
1011 Promotion
1012 System Testing
1013 Sales Rep Error
1014 Commission
1015 Operations Error
9999 Coupon Application
credit_reason_text string   No

The text description of the credit reason code.
comments string   No

Free-form comments for the credit applied to the specified account.
cancel_date string   No

The date the credit was cancelled (if any)
cancel_user string   No

The user who cancelled the credit.
cancel_comments string   No

Comments from the user who cancelled the credit
client_eligible_plan_id string 100 No

Note: This field is deprecated. Aria no longer supports client_eligible_plan_id.
client_eligible_service_id string 100 No

Note: This field is deprecated. Aria no longer supports client_eligible_service_id.
client_service_id_to_apply string 100 No

The client-defined service ID to apply the recurring credit to.
eligible_service_types object   No

A list of eligible service types

See fields below
eligible_service_plan_details object   No

See fields below
out_acct_no_2 long 22 No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
recurring_credit_no_2 long   No

The identifier for the recurring credit.
eligible_plan_instance_details object   No

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

Recommended articles

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