Account Methods
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 Methods
The following table summarizes the methods for the Account object.
Table 1-8:Account Object Methods
Method |
Description |
Creates a parent-child relationship. |
|
Deducts from this Account object the specified number of tokens of various token types. This method is equivalent to tokenTransaction with negative values for the token amounts. |
|
Extends an Account entitlement by the interval specified. (The entitlement must already exist and be on the Account when this method is called.) |
|
Extends an Account entitlement to the date specified. (The entitlement must already exist and be on the Account when this method is called.) |
|
Returns all credit grants and decrements for all Accounts. |
|
Returns the Account objects with the specified email address. |
|
Returns the Account with the specified ID (merchantAccountId). |
|
Returns all Account objects with the specified payment method. Identify the payment method with the VID, your payment method ID, or a unique identifier for the payment method type, such as a credit-card account number if the payment method type is credit card. |
|
Returns the Account object with the specified VID. |
|
Returns the Account object with the specified WebSession VID. |
|
Returns Account objects created between a specified time window. |
|
Returns an audit log of credit-related events for an Account, or for all Accounts. |
|
Returns the family of the given Account. |
|
Adds a specified amount of credit to an Account. |
|
Grants entitlement to an Account. |
|
Adds the specified number of tokens to this Account. This method is equivalent to tokenTransaction with positive values for the token amounts. |
|
Determines whether or not an Account has an entitlement. This checks Account entitlements, as well as entitlements associated with the Account’s AutoBills. |
|
Enters a payment against the Account. |
|
Redeems a specified gift card and adds the corresponding credit to an Account. |
|
Removes a child or multiple children from a parent. |
|
Reverses an Account payment made using makePayment. This method may only be used with payments using MerchantAcceptedPayment payment methods. |
|
Deducts a specified amount of credit from the Account. |
|
Revokes an entitlement from the Account. Note This method will revoke only those Entitlements granted using the grantEntitlement method; it will not revoke entitlements acquired through an AutoBill. |
|
Cancels one or more AutoBill objects (subscriptions) associated with this Account object. |
|
Returns the balance of tokens of the specified type for this Account. If no type is specified, returns the balances for all the token types in the object. |
|
Performs one or more token transactions, which can be on multiple token types, on this Account. The transactions may be positive, increasing the token balance; or negative, reducing the token balance. |
|
Merges the target Account with a given (source) Account, and returns the target Account with the merged content. |
|
Transfers credits from one Account to another. |
|
Creates or updates an Account object. |
|
Updates a payment method for this Account object. Call this method to update the payment methods on the active subscriptions (AutoBill objects) associated with this Account. |
For Users
Learn More