AutoBill.activate
Web Session Object
Transaction Object
Token Object
Season Set Object
Refund Object
RatePlan Object
Product Object
Payment Provider Object
Payment Method Object
NameValuePair Object
GiftCard Object
Entitlement Object
Chargeback Object
Campaign Object
BillingPlan Object
AutoBill Object
Address Object
Activity Object
Account Object
AutoBill.activate
Use the activate method to start an existing AutoBill that was created with a deferred start date (unknownStart = True) and is in status: Pending Activation. Calling activate sets the startTimestamp to today and initiates the billing process.
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.
auth: credentials required to authenticate this request.
autobill: the object of type AutoBill to activate.
Output
status: the status of the activated
return: an object of type Return that indicates the success or failure of the call.
autobill: the AutoBill object whose monthly billing day was updated.
Returns
In addition to those listed in Standard Return Codes, this call returns:
Return Code |
Return String |
400 |
One of the following:
|
Example
//---unknownStart---
autobill->update( unknownStart => 1 );
autobillId = autobill->id();
.
.
//once ready to start autobill
autobill->load( autobillId )->activate();
//---knownStart---
nextWeek = Date->nextWeek();
autobill->update( startTimestamp => nextWeek );
autobillId = autobill->id();
.
.
//if ready prior to startTimestamp, autobill can activate
autobill->load( autobillId )->activate();
For Users
Learn More