error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |
recurring_credit_info | hash | |
recurring_credit_no | long | The identifier for the recurring credit. |
create_date | string | The date the recurring credit record was created. |
create_user | string | The user who created the recurring credit record. |
update_date | string | The date the recurring credit record was last updated. |
update_user | string | The user who last updated the recurring credit record |
first_credit_date | string | The first date that recurring credit was applied to the account. |
last_credit_date | string | The last date that recurring credit will be applied to the account. |
next_credit_date | string | The next date that a recurring credit will be applied to the account (assuming the last_credit_date has not passed) |
credit_amount | double | The monetary amount of the credit to be applied for each iteration of the recurring credit sequence. |
currency_cd | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
credits_completed | long | The number of credits that have been applied to the account |
credits_remaining | long | The number of remaining credits to apply to the account |
credit_interval_months | long | The interval (in months) between credits to the account |
eligible_plan_no | long | The plan number that is eligible to apply recurring credit. |
eligible_plan_name | string | The name of the eligible plan number. |
eligible_service_no | long | The service number eligible for recurring credit |
eligible_service_name | string | The name of the eligible service. |
service_no_to_apply | long | The service number to apply the recurring credit to. |
service_name_to_apply | string | The name of the service to apply the recurring credit to. |
credit_status_cd | long | The status code for the recurring credit. |
credit_status_label | string | The label for the recurring credit status code. |
credit_reason_cd | long | The reason code for the application of credit toward the account specified Allowable Values Values | 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 | The text description of the credit reason code. |
comments | string | Free-form comments for the credit applied to the specified account. |
cancel_date | string | The date the credit was cancelled (if any) |
cancel_user | string | The user who cancelled the credit. |
cancel_comments | string | Comments from the user who cancelled the credit |
client_eligible_plan_id | string | The client-defined plan ID that is eligible to apply recurring credit. |
client_eligible_service_id | string | The client-defined service ID eligible for recurring credit |
client_service_id_to_apply | string | The client-defined service ID to apply the recurring credit to. |
eligible_service_types | hash | A list of eligible service types |
eligible_service_types | string | Service type code for which the credit is applicable. Allowable Values Values | 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 | |
eligible_service_plan_details | hash | |
plan_no | long | The plan numbers that is eligible to apply recurring credit. |
plan_name | string | The name of the eligible plan number. |
service_no | long | The service numbers eligible for recurring credit |
service_name | string | The name of the eligible service. |
client_plan_id | string | The client-defined plan IDs that is eligible to apply recurring credit. |
client_service_id | string | The client-defined service ids eligible for recurring credit |