Account.extendEntitlementToDate
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
Account.extendEntitlementToDate
The extendEntitlementToDate method extends an Account entitlement to the date provided.
(The entitlement must already exist and be on the Account when this method is called.)
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 to which this extension applies.
entitlement: an object of type Entitlement for the given Account.
merchantEntitlementId: the merchant's unique ID for this entitlement. This may be specified in lieu of the full Entitlement object. Note that either the Entitlement or the merchantEntitlementIdmust be specified.
extensionDate: the new end time for entitlement.
note: an optional memo regarding the entitlement extension.
Output
return: an object of type Return that indicates the success or failure of the call.
account: the Account object with modified entitlements.
Returns
In addition to those listed in Standard Return Codes, this call returns:
Return Code |
Return String |
400 |
One of the following:
|
Example
// to extend entitlements to a given date
$acct = new Account();
$acct->setMerchantAccountId('xyz123');
$entitle = new Entitlement();
$entitle->setDescription('For playing Scrabble');
$entitle->setStartTimestamp($today);
$entitle->setEndTimestamp($tomorrow);
$entitle->setMerchantEntitlementId('bac');
$acct->grantEntitlement($entitle);
$next_friday = '2011-08-12T23:59:59Z';
$response = $acct->extendEntitlementToDate(
$entitle,
null,
$next_friday,
'Extended until next friday'
);
// check $response ...
For Users
Learn More