Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo core api > get_recurring_credit_info_m

get_recurring_credit_info_m

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

For information on error messages generated by this API, see get_recurring_credit_info_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  filter_credit_no long 22 The recurring credit number to use in order to filter results.
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 100 Name of the locale.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
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_credits_details hash  
brd_arrow.gif out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts. DEPRECATED
brd_arrow.gif out_acct_no_2 long Aria-assigned account identifier. This value is unique across all Aria-managed accounts. 
brd_arrow.gif out_master_plan_instance_no long The Master Subscription plan instance number.
brd_arrow.gif out_client_mp_instance_id string Client-defined Master plan Subscription plan instance ID.
brd_arrow.gif recurring_credit_no long The identifier for the recurring credit. DEPRECATED
brd_arrow.gif recurring_credit_no_2 long The identifier for the recurring credit.
     
brd_arrow.gif create_date string The date the recurring credit record was created.
brd_arrow.gif create_user string The user who created the recurring credit record.
brd_arrow.gif update_date string The date the recurring credit record was last updated.
brd_arrow.gif update_user string The user who last updated the recurring credit record
brd_arrow.gif first_credit_date string The first date that recurring credit was applied to the account.
brd_arrow.gif last_credit_date string The last date that recurring credit will be applied to the account.
brd_arrow.gif 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)
brd_arrow.gif credit_amount double The monetary amount of the credit to be applied for each iteration of the recurring credit sequence.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif credits_completed long The number of credits that have been applied to the account
brd_arrow.gif credits_remaining long The number of remaining credits to apply to the account
brd_arrow.gif credit_interval_months long The interval (in months) between credits to the account
brd_arrow.gif eligible_plan_no long The plan number that is eligible to apply recurring credit. (Deprecated)
brd_arrow.gif eligible_plan_name string The name of the eligible plan number. (Deprecated)
brd_arrow.gif eligible_service_no long The service number eligible for recurring credit (Deprecated)
brd_arrow.gif eligible_service_name string The name of the eligible service. (Deprecated)
brd_arrow.gif service_no_to_apply long The service number to apply the recurring credit to.
brd_arrow.gif service_name_to_apply string The name of the service to apply the recurring credit to.
brd_arrow.gif credit_status_cd long The status code for the recurring credit.   Allowable Values
brd_arrow.gif credit_status_label string The label for the recurring credit status code.
brd_arrow.gif credit_reason_cd long The reason code for the application of credit toward the account specified   Allowable Values
brd_arrow.gif credit_reason_text string The text description of the credit reason code.
brd_arrow.gif comments string Free-form comments for the credit applied to the specified account.
brd_arrow.gif cancel_date string The date the credit was cancelled (if any)
brd_arrow.gif cancel_user string The user who cancelled the credit.
brd_arrow.gif cancel_comments string Comments from the user who cancelled the credit
brd_arrow.gif client_eligible_plan_id string The client-defined plan ID that is eligible to apply recurring credit. (Deprecated)
brd_arrow.gif client_eligible_service_id string The client-defined service ID eligible for recurring credit (Deprecated)
brd_arrow.gif client_service_id_to_apply string The client-defined service ID to apply the recurring credit to.
eligible_plan_instance_details hash  
  brd_arrow.gif plan_instance_no long The plan instance number that is eligible for this credit.
  brd_arrow.gif client_plan_instance_id string The client defined plan instance identifier.
  brd_arrow.gif plan_instance_service_no long The service number associated with the plan instance that is eligible for this credit.
  brd_arrow.gif  client_plan_instance_service_id string The client-defined identifier for the service associated with this plan instance.
eligible_service_plan_details hash  
brd_arrow.gif plan_no long The plan numbers that are eligible for the recurring credit.
brd_arrow.gif plan_name string The name of the eligible plan.
brd_arrow.gif service_no long The service numbers eligible for recurring credit
brd_arrow.gif service_name string The name of the eligible service.
brd_arrow.gif client_plan_id string The client-defined plan IDs that are eligible for the recurring credit.
brd_arrow.gif client_service_id string The client-defined service IDs eligible for recurring credit
eligible_service_types hash A list of eligible service types
brd_arrow.gif eligible_service_types string Service type code to which the credit is applicable.   Allowable Values
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.