Skip to main content
Vindicia Knowledge Center

BillingPlan.fetchByBillingPlanStatus

BillingPlan.fetchByBillingPlanStatus

BillingPlan.fetchByBillingPlanStatus

The fetchByBillingPlanStatus method returns one or more BillingPlan objects whose status matches the input (either Active or Suspended). For example, call this method to retrieve all active billing plans, and present them to a customer as subscription choices.

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.

status: a string that describes the BillingPlan status (either Active or Suspended), which serves as the search criterion.

Output

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

billingPlans: an array of one or more BillingPlan objects whose status matches the input.

Returns

This method returns the codes listed in Standard Return Codes.

Example

// Create an array of billing plan object

$plan = new BillingPlan();

// now load all billing plans that have a status of Suspended

$response = $plan->fetchByBillingPlanStatus('Active');
if($response['returnCode'] == 200) {

$fetchedPlans = $response['data']->billingPlans;
if ($fetchedPlans != null ) {

foreach ($fetchedPlans as $billPlan) {

// process a fetched plan here

}

}

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top