Skip to main content
Aria Knowledge Central

get_installment_term_m

Gets the details of the specified installment term. If no installment term is specified, it returns the data for all installment terms.

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.
  client_installment_term_id long   Client-defined account identifier.
  OR      
  installment_term_id long 50 Aria-assigned account identifier.

Output Arguments

Field Name Field Type Description
error_code    
error_message    
installment_term_details array Installment term details assigned to an account
client_installment_term_id string Specifies client installment term id
installment_term_name string Specifies installment term name
installment_term_description string Installment term description
aligned_installment string
Aligned installment schedule with existing master plan instance. Allowable values are: Yes (Y) - Aligned with existing master plan instance OR No (N) - Its own installment schedule and due dates. If aligned, installment amount will be charged along with master plan instance anniversary invoice/statement.
term_type string
M (Months), W (Weeks), D (Days). If Null, will be treated as Months
term_length int
Installment term length. For aligned_installment = N, the input will be used jointly with interval type, so for example if interval type is M (Monthly), and users enter 36 then, installment period is 36 months.
installment_term_interval int
Installment interval, works jointly with terms type. For example: 2 on interval and months in terms type mean installment is due every 2 months. If defined, must be less than terms length.
days_to_start int
Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after a purchase or subscription date that the first installment will start. For example: if 5 is passed, then 5 days after a purchase date 1st installment will start. If 0 is passed, then 1st installment will start on purchase date.
days_until_due int
Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due.
lump_sum_type string Lump sum type determines type of charges to be considered as a lump sum. Two types of lump sum are: proportionately split (tax/charge) or tax only. Allowable values are: P for proportionately split charge/tax; T - for purchase tax only.
lump_sum_amount float Applicable only when lump sump type is proportionately split (lump_sum_type = P). A one-time amount that will reduce the total installment to be spread over the course of installment term. For example: a $1200 phone purchase with $200 lump sump will reduce the total installment amount to $1000, which will be spread monthly over 10 months installment term ($100 per month). Lump sum amount is mandatory when only when lump_sum_type is P (proportionately split charge/tax).
aligned_lump_sum int Applicable only for aligned installment (aligned_installment = Y). Determines when to notify customers of the lump sum. Allowable values are: 0 - Aligned with when an invoice is created; 1 - Aligned with the 1st installment.
lump_sum_days int Applicable only for independent installment (aligned_installment = N). Determines how many days after a purchase or invoice date that a lump sum is charged and be notified to customers. For example: if 3 is passed, then 3 days after an invoice date, a lump sum will be charged. If 0 is passed, then 1st installment will start (and be notified to customers) on purchase date (invoice date).
lump_sum_days_until_due int Applicable only for independent installment. Determines how many days after customers are notified that a lump sum is due. For example: if 5 is passed, then 5 days after customers are notified, the lump sum will be due.  If it's NULL, it will be treated as 0, and lump sum is due when it's notified to customers.
installment_term_status string
Installment status related to installment terms (Activated or Deactivated)
  • Was this article helpful?