AutoBill

Methods

update http://soap.vindicia.com/AutoBill#update

Input (update_in)

Name	Type
auth	Authentication
autobill	AutoBill
duplicateBehavior	DuplicateBehavior
validatePaymentMethod	xsd:boolean
minChargebackProbability	xsd:int

Output (update_out)

Name	Type
return	Return
autobill	AutoBill
created	xsd:boolean
authStatus	TransactionStatus
firstBillDate	xsd:date
firstBillAmount	xsd:decimal
firstBillingCurrency	xsd:string

Creates a new AutoBill object or updates an existing one.

Input Fields

auth: Credentials required to authenticate this request
autobill: Object to create
duplicateBehavior: This parameter is reserved for future use and is currently not supported
validatePaymentMethod: Validate the payment method before saving. AutoBill will not be saved if validation is requested and fails.
minChargebackProbability: If Chargeback Probability from risk scoring is greater than this, the transaction will fail. Default is 100 (all payment methods are applied).

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobill: The resultant object
created: True if the object was created new
authStatus: If payment method validation was requested, this object will contain more information on response to the validation from the payment processor. You can examine this object for things such as Address Verification (AVS) response code, CVV response code, etc.
firstBillDate: Date of first billing on this object
firstBillAmount: Amount of first billing on this object
firstBillingCurrency: Currency of first billing on this object

cancel http://soap.vindicia.com/AutoBill#cancel

Input (cancel_in)

Name	Type
auth	Authentication
autobill	AutoBill
disentitle	xsd:boolean
force	xsd:boolean

Output (cancel_out)

Name	Type
return	Return
autobill	AutoBill

Cancels an AutoBill. Use the force flag to allow cancelling within a commitment period.

Input Fields

auth: Credentials required to authenticate this request
autobill: Object to create
disentitle: If true, also immediately disentitles the Account associated with this AutoBill for relevant Products.
force: If true, allows cancelling even if within a defined commitment period.

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobill: The resultant object

delayBillingToDate http://soap.vindicia.com/AutoBill#delayBillingToDate

Input (delayBillingToDate_in)

Name	Type
auth	Authentication
autobill	AutoBill
newBillingDate	xsd:date

Output (delayBillingToDate_out)

Name	Type
return	Return
autobill	AutoBill
nextBillingDate	xsd:date
nextBillingAmount	xsd:decimal
nextBillingCurrency	xsd:string

Delays billing on a given autobill until a particular date

Input Fields

auth: Credentials required to authenticate this request
autobill: The AutoBill object
newBillingDate: Date to delay billing until

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobill: The resultant object
nextBillingDate: Date of next billing after the delay
nextBillingAmount: Amount of next billing after the delay
nextBillingCurrency: Currency of next billing

delayBillingByDays http://soap.vindicia.com/AutoBill#delayBillingByDays

Input (delayBillingByDays_in)

Name	Type
auth	Authentication
autobill	AutoBill
delayDays	xsd:int

Output (delayBillingByDays_out)

Name	Type
return	Return
autobill	AutoBill
nextBillingDate	xsd:date
nextBillingAmount	xsd:decimal
nextBillingCurrency	xsd:string

Delays billing a given number of days

Input Fields

auth: Credentials required to authenticate this request
autobill: The AutoBill object
delayDays: Number of days to delay billing by

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobill: The resultant object
nextBillingDate: Date of next billing after the delay
nextBillingAmount: Amount of next billing after the delay
nextBillingCurrency: Currency of next billing

changeBillingDayOfMonth http://soap.vindicia.com/AutoBill#changeBillingDayOfMonth

Input (changeBillingDayOfMonth_in)

Name	Type
auth	Authentication
autobill	AutoBill
dayOfMonth	xsd:int

Output (changeBillingDayOfMonth_out)

Name	Type
return	Return
autobill	AutoBill
nextBillingDate	xsd:date
nextBillingAmount	xsd:decimal
nextBillingCurrency	xsd:string

Delays a billing to a given day of the month. Note: You can also change the day in the AutoBill and call update but this function returns useful information.

Input Fields

auth: Credentials required to authenticate this request
autobill: The AutoBill object
dayOfMonth: Day of month to delay to, between 1 and 31, inclusive

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobill: The resultant object
nextBillingDate: Date of next billing after the delay
nextBillingAmount: Amount of next billing after the delay
nextBillingCurrency: Currency of next billing

fetchByAccountAndProduct http://soap.vindicia.com/AutoBill#fetchByAccountAndProduct

Input (fetchByAccountAndProduct_in)

Name	Type
auth	Authentication
account	Account
product	Product

Output (fetchByAccountAndProduct_out)

Name	Type
return	Return
autobills	ArrayOfAutoBills

Loads an array of autobills by an Account and Product

Input Fields

auth: Credentials required to authenticate this request
account: Account to load AutoBill for
product: Product to load AutoBill for

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobills: The resultant object

fetchByMerchantAutoBillId http://soap.vindicia.com/AutoBill#fetchByMerchantAutoBillId

Input (fetchByMerchantAutoBillId_in)

Name	Type
auth	Authentication
merchantAutoBillId	xsd:string

Output (fetchByMerchantAutoBillId_out)

Name	Type
return	Return
autobill	AutoBill

Loads an autobill by merchants's unique id of subscribed item

Input Fields

auth: Credentials required to authenticate this request
merchantAutoBillId: Merchant's unique id for subscription

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobill: The resultant object

fetchByVid http://soap.vindicia.com/AutoBill#fetchByVid

Input (fetchByVid_in)

Name	Type
auth	Authentication
vid	xsd:string

Output (fetchByVid_out)

Name	Type
return	Return
autobill	AutoBill

Loads an autobill by Vindicia's unique ID

Input Fields

auth: Credentials required to authenticate this request
vid: Vindicia ID for the object

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobill: The resultant object

fetchByEmail http://soap.vindicia.com/AutoBill#fetchByEmail

Input (fetchByEmail_in)

Name	Type
auth	Authentication
email	xsd:string

Output (fetchByEmail_out)

Name	Type
return	Return
autobills	ArrayOfAutoBills

Loads an array of autobills by customer email

Input Fields

auth: Credentials required to authenticate this request
email: Email address to load by

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobills: The resultant object

fetchByAccount http://soap.vindicia.com/AutoBill#fetchByAccount

Input (fetchByAccount_in)

Name	Type
auth	Authentication
account	Account

Output (fetchByAccount_out)

Name	Type
return	Return
autobills	ArrayOfAutoBills

Loads an array of autobills by Account object

Input Fields

auth: Credentials required to authenticate this request
account: Account to load by

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobills: The resultant object

futureRebills http://soap.vindicia.com/AutoBill#futureRebills

Input (futureRebills_in)

Name	Type
auth	Authentication
autobill	AutoBill
quantity	xsd:int

Output (futureRebills_out)

Name	Type
return	Return
transactions	ArrayOfTransactions

Returns projected future Transaction objects for a given autobill object

Input Fields

auth: Credentials required to authenticate this request
autobill: Object to create
quantity: Number of period to project forward

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transactions: The projected, future transactions

fetchDeltaSince http://soap.vindicia.com/AutoBill#fetchDeltaSince

Input (fetchDeltaSince_in)

Name	Type
auth	Authentication
timestamp	xsd:dateTime
page	xsd:int
pageSize	xsd:int

Output (fetchDeltaSince_out)

Name	Type
return	Return
autobills	ArrayOfAutoBills

Loads a list of autobills that changed in status after the time stamp provided

Input Fields

auth: Credentials required to authenticate this request
timestamp: All autobills that changed in status after this time stamp
page: page number to begin results returned, starts at 0.
pageSize: Number of results returned per page

Output Fields

return: Basic results of this request (success, failure, error, etc.)
autobills: Array of AutoBill objects whose status changed after the timestamp