BillingPlan.fetchByVid

The fetchByVid method returns a BillingPlan object whose VID matches the input.

When you first create a BillingPlan object with the update() method, leave the VID field empty; CashBox automatically assigns the object a unique VID inside the BillingPlan object that you receive in response to the call. Use this VID to retrieve the object later.

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.

vid: the BillingPlan object’s Vindicia identifier, which serves as the search criterion.

Output

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

billingPlan: the BillingPlan object whose VID matches the input.

Returns

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

Return Code	Return String
404	No BillingPlans found for VID input-vid.

Example

$planVid = 'MyVindiciaVID';

// Create a billing plan object

$plan = new BillingPlan();

// now load a billing plan record into the BillingPlan object by VID

$response = $plan->fetchByVid($planVid);

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

$fetchedPlan = $response['data']->billingPlan;

// process fetched billing plan here

}