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.

Specifies the installment term number

Specifies the installment term client ID

Aria-assigned unique identifier of the locale used for translations.

Alternative field: locale_name

Name of the locale to which the translations belong.

Alternative field: locale_no

Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Aria-assigned error identifier. 0 indicates no error

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

The installment_term_details associated with this method.

See fields below

Name of the locale to which the translations belong.

Alternative field: locale_no

Aria-assigned unique identifier of the locale used for translations.

Alternative field: locale_name

Aria-assigned unique identifier for client installment term

Specifies installment term name

Installment term description

Aria-assigned unique identifier for client installment term

Specifies client installment term id

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 invoice/statement.

M (Months), W (Weeks), D (Days). If Null, will be treated as Months

For aligned_installment = N, the input will be used jointly with interval type, for example if interval type is M (Monthly), and users enter 36 on term_length then, installment period is 36 months. For aligned_installment = Y, value entered on term_length is 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.

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.

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.

Installment status related to installment terms (Active, Deactivated, etc.)

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.

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. For independent installment, if it's NULL, it will be treated as 0, and lump sum is due when it's notified to customers. If it's NULL for aligned installment, it will follow the statement due date that lump sum is on.

Array that contains all the translated values for a given locale.

See fields below