Aria-assigned unique identifier indicating the Aria client providing service to this account.

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

Installment no on product catalog. If null, then it selects installment default

Alternative required field: client_installment_term_id

Specifies client installment id. If null, then it selects the installment default

Alternative required field: installment_term_no

Specifies installment term name

Installment term description

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.

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.

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 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.

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).

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. If NULL, then it will follow the invoice days until due. If 0 is passed then it’s due on purchase date (invoice date).

Lump sum type determines type of charges to be considered as a lump sum. 2 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.

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).

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. If NULL, but aligned_installment = Y and lump_sum_type are passed, then aligned_lump_sum will be treated as 0 - Aligned with when an invoice is created. When aligned_installment = N, value passed will be ignored.

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).

Applicable for both types of 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 follow invoice days until due, and if it's 0 lump sum is due when it's notified to customers.

Aria-assigned error identifier. 0 indicates no error

Textual description of any error that occurred. "OK" if there was no error.

Installment terms no

Client installment terms ID