RatePlan.deductEvent

The deductEvent method reduces a customer’s unbilled Event balance.

Use this method to pass in a number of Events to subtract from a customer’s balance. To pass in a specific, existing Event, use reverseEvent.

Note This method may not be used against a billed Event.

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.

event: an array of Event objects.

Output

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

Returns

This method returns the codes listed in Standard Return Codes.

Example

$rateplan = new RatePlan;
$event = new Event;

$event->setMerchantEventId('rating_129');
$event->setMerchantAutoBillId('ab_715');
$event->setAmount(2);

$response = $rateplan->deductEvent(array($event));

// check $response