AutoBill.delayBillingByDays

The delayBillingByDays method delays the next billing and extends the AutoBill end-date, which corresponds to that for the entitlements granted by AutoBill, by the specified number of days. Call this method to credit the customer with additional subscription time, by postponing a customer’s next billing by a finite duration.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

autobill: the AutoBill object whose billing to delay. Identify this object by populating it with its VID or merchantAutoBillId.

delayDays: the number of days by which to delay the billing. (Must be a positive integer.)

movePermanently: when set to true, makes the altered billing date change permanent for all subsequent billings.

Output

return: an object of type Return that indicates the success or failure of the call.

autobill: the AutoBill object whose billing was delayed by the input number of days.

nextBillingDate: the date of the next billing after the delay is in effect.

nextBillingAmount: the amount of the next billing after the delay is in effect.

nextBillingCurrency: the currency of the next billing after the delay is in effect.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code	Return String
400	One of the following: Days to delay must be a positive integer. Must specify AutoBill to delay billing for. Unable to delay billing to date: error-description.

Example

$autobill = new AutoBill();
$autobill->setMerchantAutoBillId('xyz');
$response = $autobill->delayBillingByDays(25, true);

if($response['returnCode'] == 200) {

$nextBillingDate = $response['nextBillingDate'];
$nextBillingAmt = $response['nextBillingAmount'];
print "Customer will be billed on " . $nextBillingDate.

" for US $" . $nextBillingAmt . "\n";

}