BillingSettings

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  BillingSettings
Represents information about recurring billing settings assigned to a particular merchant.
balancingAlgorithmType
References: Merchant.Account Balance Algorithm CL
XML Representation: attribute
Attributes:
Default Value
For UniBill only.
Represents the type of balancing algorithm that is used to balance payments on customer account.
codeUniqenessScopeMode
References: Merchant.Code Uniqueness Scope CL
XML Representation: attribute
Attributes:
Default Value
For UniBill only.
Represents the type of scope, within which customer account's ID is unique.
forecastingPeriod
References: Merchant.Ibilling Forecasting Period
XML Representation: attribute
Attributes:
Default Value
Period in months for which forecasting data needs to be available within the system.

Forecasting data shows expected recurring billing revenue projected in time in the future. A value of 12 in this field indicates that the system will provide projections for up to 12 months.
isMultiplePaymentPlanModeEnabled
References: Merchant.Is Disallow Multiple Payment Plans
XML Representation: attribute
Attributes:
Default Value
UniBill only.
Indicates whether multiple payment plans are allowed on a single customer account.
isChargebackFeeReversalEnabled
References: Merchant.Is Reverse Chargeback Fee
XML Representation: attribute
Attributes:
Default Value
Indicates whether chargeback fees are reversed when chargebacks are reversed.
isSchedulePaymentDeclinesEnabled
XML Representation: attribute
Attributes:
Default Value
Indicates whether decline fees are assessed for declines coming from scheduled payments.
isPaymentOptionDeclineDeactivationEnabled
XML Representation: attribute
Attributes:
Default Value
Indicates whether payment option is disabled when defined number of declines is received for this payment option.
creditBureauReportingStatus
References: Merchant.Credit Agency Status CL
XML Representation: attribute
Attributes:
Default Value
Represents the type of reporting status of the merchant within the credit bureau.
invoiceWriteoffAge
References: Merchant.Terminal Invoice Age
XML Representation: attribute
Attributes:
Default Value
Age of a non-committed debt which cannot be reported to credit bureau, at which the outstanding debt is written off.
customAccountWriteoffAge
References: Merchant.Terminal Customer Account Age
XML Representation: attribute
Attributes:
Default Value
Age at which all of the payment plans of a customer get terminated.
isSkipTracingEnabled
References: Merchant.Is Skip Trace Enabled
XML Representation: attribute
Attributes:
Default Value
For UniBill only.
Indicates whether skiptracing process is enabled on a customer account.
skipTracingPeriod
References: Merchant.Skip Trace Period
XML Representation: attribute
Attributes:
Default Value
Period in days during which two subsequent skiptraces will not be allowed. For example, if skip trace period is 60 days and the skiptrace is done on January 1st, another skiptrace on this account will not be allowed until March 1st.
letterMailMode
References: Merchant.Mail Mode CL
XML Representation: attribute
Attributes:
Default Value
Represents the type of selected mailing mode that is used for this merchant.
isBadPhoneRetentionEnabled
References: Merchant.Is Keep Bad Phones
XML Representation: attribute
Attributes:
Default Value
Indicates whether bad phone numbers are kept on the account after skiptracing process completes.
collectionsPeriod
References: Merchant.Collections Period
XML Representation: attribute
Attributes:
Default Value
Period in days after which collections fees are applied.

XML Sample:

<billing-settings
    balancingAlgorithmType="AB" 
    codeUniqenessScopeMode="A" 
    forecastingPeriod="10" 
    isMultiplePaymentPlanModeEnabled="true" 
    isChargebackFeeReversalEnabled="true" 
    isSchedulePaymentDeclinesEnabled="true" 
    isPaymentOptionDeclineDeactivationEnabled="true" 
    creditBureauReportingStatus="F" 
    invoiceWriteoffAge="10" 
    customAccountWriteoffAge="10" 
    isSkipTracingEnabled="true" 
    skipTracingPeriod="100" 
    letterMailMode="D" 
    isBadPhoneRetentionEnabled="true" />

"<billing-settings balancingAlgorithmType=\"AB\" codeUniqenessScopeMode=\"A\" forecastingPeriod=\"10\" isMultiplePaymentPlanModeEnabled=\"true\" isChargebackFeeReversalEnabled=\"true\" isSchedulePaymentDeclinesEnabled=\"true\" isPaymentOptionDeclineDeactivationEnabled=\"true\" creditBureauReportingStatus=\"F\" invoiceWriteoffAge=\"10\" customAccountWriteoffAge=\"10\" isSkipTracingEnabled=\"true\" skipTracingPeriod=\"100\" letterMailMode=\"D\" isBadPhoneRetentionEnabled=\"true\" />"

JSON Sample:

{
  "balancingAlgorithmType": "AB",
  "codeUniqenessScopeMode": "A",
  "forecastingPeriod": "10",
  "isMultiplePaymentPlanModeEnabled": true,
  "isChargebackFeeReversalEnabled": true,
  "isSchedulePaymentDeclinesEnabled": true,
  "isPaymentOptionDeclineDeactivationEnabled": true,
  "creditBureauReportingStatus": "F",
  "invoiceWriteoffAge": "10",
  "customAccountWriteoffAge": "10",
  "isSkipTracingEnabled": true,
  "skipTracingPeriod": "100",
  "letterMailMode": "D",
  "isBadPhoneRetentionEnabled": true
}

XURL Sample:

?balancingAlgorithmType=AB&codeUniqenessScopeMode=A&forecastingPeriod=10&isMultiplePaymentPlanModeEnabled=true&isChargebackFeeReversalEnabled=true&isSchedulePaymentDeclinesEnabled=true&isPaymentOptionDeclineDeactivationEnabled=true&creditBureauReportingStatus=F&invoiceWriteoffAge=10&customAccountWriteoffAge=10&isSkipTracingEnabled=true&skipTracingPeriod=100&letterMailMode=D&isBadPhoneRetentionEnabled=true&
balancingAlgorithmType=AB
codeUniqenessScopeMode=A
forecastingPeriod=10
isMultiplePaymentPlanModeEnabled=true
isChargebackFeeReversalEnabled=true
isSchedulePaymentDeclinesEnabled=true
isPaymentOptionDeclineDeactivationEnabled=true
creditBureauReportingStatus=F
invoiceWriteoffAge=10
customAccountWriteoffAge=10
isSkipTracingEnabled=true
skipTracingPeriod=100
letterMailMode=D
isBadPhoneRetentionEnabled=true