> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slm.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 [The Return Object](The_Return_Object).

## 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
      }
   }
}
```

**Parent topic:**[BillingPlan Methods](../topics/BillingPlan_Methods)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.