Skip to main content
Vindicia Knowledge Center

AutoBill.fetchByAccount

AutoBill.fetchByAccount

AutoBill.fetchByAccount

The fetchByAccount method returns one or more AutoBill objects whose Account object matches the input. This method is useful for looking up a customer’s subscriptions on your site.

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.

account: the Account object that serves as the search criterion. Use the merchantAccountId or VID to identify the object.

includeChildren: an optional Boolean flag that, if set to true, includes any children associated with this Account. If this flag is omitted, CashBox will interpret it as false, and constructs the query without looking at any child account.

page: (optional) page number, starting at 0, to begin results returned. For example, if the total number of results is 85 and pageSize is 10:

  • Specifying 0 for page gets the results from 1 through 10.
  • Specifying 2 for page gets the results from 21 through 30.

pageSize: (optional) number of records to return per call. This value must be greater than 0.

Output

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

autobills: an array of one or more AutoBill objects whose Account object matches the input.

Returns

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

Return Code

Return String

400

Data validation error: error-description.

Example

// Create and populate an Account object

$account = new Account();
$account->setMerchantAccountId('abc101');
$page = 0;
$pageSize = 100;

$autobill = new AutoBill();

$response = $autobill->fetchByAccount($account, ’’, $page, $pageSize);
if($response['returnCode'] == 200) {

$fetchedAutoBills= $response['data']->autobills;

foreach ($fetchedAutoBills as $autobill) {

// process each autobill found here

print "Found account with id: "

. $autobill->getMerchantAutoBillId() . "\n";

}

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top