RatePlan Methods

The following table summarizes the methods for the RatePlan object.

Method	Description
RatePlan.deductEvent	Deducts Events from the unbilled Unit balance.
RatePlan.fetchAll	Fetches all existing Rate Plans.
RatePlan.fetchByMerchantRatePlanId	Fetches an existing `RatePlan` by its `merchantRatePlanId`.
RatePlan.fetchByVid	Fetches an existing `RatePlan` by its `VID`.
RatePlan.fetchEventById	Fetches an `Event` by its `merchantEventId`.
RatePlan.fetchEventByVid	Fetches an `Event` by its VID.
RatePlan.fetchEvents	Fetches all `Events` by the specified `Account`, `AutoBill`, `RatePlan`, or `Product`. If none of these are specified, fetches all `Events`.
RatePlan.fetchUnbilledEvents	Returns unbilled `Events` for the input `AutoBill`, `Account`, `Product`, or `RatePlan`. If none of these are specified, fetches all unbilled `Events`.
RatePlan.fetchUnbilledRatedUnitsTotal	Returns an array of `RatedUnitSummary` objects, broken out by `AutoBillItem`.
RatePlan.recordEvent	Records `Events` against a defined `Account`, `AutoBill`, or `AutoBillItem`.
RatePlan.reverseEvent	Reverses one or more existing unbilled `Events`.