> ## 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.

# RatePlan.fetchUnbilledRatedUnitsTotal

The `fetchUnbilledRatedUnitsTotal` method returns the total number and currency value for the specified unbilled Events.

**Note:** If no input parameters are specified, this method will return the total for all unbilled `Events` in your Subscribe system. Specifying any of the input parameters is additive, in that you may specify any combination of listed parameters to narrow your return.

## 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` for which `Events` should be fetched.

*autobill*: the `AutoBill` for which `Events` should be fetched.

*product*: the `Product` for which `Events` should be fetched.

*ratePlan*: the `RatePlan` for which `Events` should be fetched.

*startTimestamp*: the starting timestamp (lower limit) for the range of `Events` you wish to retrieve. (Optional.)

*endTimestamp*: the ending time stamp (upper limit) for the range of `Events` you wish to retrieve. (Optional.)

*page*: (optional) the page number, starting at 0, for which to return the results. 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) the number of records to display per page 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.

*ratedUnitSummary*: the array of specified `RatedUnitSummary` objects, broken out by `AutoBillItem`.

## Returns

This method returns the codes listed in [The Return Object](The_Return_Object#).

## Example

```

// For a specific product on a specific AutoBill
// fetch the array of ratedUnitSummary objects
// for all RatePlans within a specific date range.

$rateplan = new RatePlan;
$response = $rateplan->fetchUnbilledRatedUnitsTotal(
   null, # account
   $myAutoBill, #
   $myProduct, #
   null, # ratePlan
   '2012-03-01', # start
   '2012-03-31', # end
   0, # page
   50, # pageSize
);
if ($response['returnCode'] == 200) {
   $summaries = $response->['data']->ratedUnitSummary;
   foreach ($summaries as $sum) {
      print $sum->ratedUnitTotal;
      print $sum->currentTotalRatedUnitsBill;
   }
}
```

**Parent topic:**[RatePlan Methods](../topics/RatePlan_Methods)


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