Skip to main content
Aria Knowledge Central

create_installment_terms_m

Creates installment terms to allow multiple payments for a Non-Subscription Offering. Once created, the terms must be mapped to a product when creating an order.

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 client_installment_term_id string 100 Specifies client installment term id.
required-icon.png installment_term_name string 100 Specifies installment term name.
  description string 1000 Installment term description.
required-icon.png aligned_installment string 1
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 statement.
  term_type string 1
Installment term types: M (Months), W (Weeks), D (Days). Mandatory when aligned_installment is N (No), if Null, will be treated as Months. For aligned_installment Y (Yes), this is irrelevant and will be ignored if passed.
  term_length int 8
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. For aligned_installment = Y, this will be interpreted as number of statements that the installment amount will be part of.
  installment_term_interval int 1
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. Mandatory if aligned_installment is N (No). For aligned_installment Y (Yes), this is irrelevant and will be ignored if passed.
  days_to_start int 8
Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after a purchase or invoice date that the first installment will start. For example: if 5 is passed, then 5 days after an invoice date, 1st installment will start and be notified to customers. If 0 is passed, then 1st installment will start (and be notified to customers) on purchase date (invoice date).
  days_until_due int 8
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.

Output Arguments

Field Name Field Type Description
error_code    
error_message    
installment_term_no string Aria-assigned installment terms no
client_installment_term_id string Client installment terms ID
  • Was this article helpful?