Skip to main content
Vindicia Knowledge Center

Account Methods

Account Methods

Account Methods

The following table summarizes the methods for the Account object.

Table 1-8:Account Object Methods

Method

Description

Account.addChildren

Creates a parent-child relationship.

Account.decrementTokens

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.

Account.extendEntitlementByInterval

Extends an Account entitlement by the interval specified.

(The entitlement must already exist and be on the Account when this method is called.)

Account.extendEntitlementToDate

Extends an Account entitlement to the date specified.

(The entitlement must already exist and be on the Account when this method is called.)

Account.fetchAllCreditHistory

Returns all credit grants and decrements for all Accounts.

Account.fetchByEmail

Returns the Account objects with the specified email address.

Account.fetchByMerchantAccountId

Returns the Account with the specified ID (merchantAccountId).

Account.fetchByPaymentMethod

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.

Account.fetchByVid

Returns the Account object with the specified VID.

Account.fetchByWebSessionVid

Returns the Account object with the specified WebSession VID.

Account.fetchCreatedSince

Returns Account objects created between a specified time window.

Account.fetchCreditHistory

Returns an audit log of credit-related events for an Account, or for all Accounts.

Account.fetchFamily

Returns the family of the given Account.

Account.grantCredit

Adds a specified amount of credit to an Account.

Account.grantEntitlement

Grants entitlement to an Account.

Account.incrementTokens

Adds the specified number of tokens to this Account. This method is equivalent to tokenTransaction with positive values for the token amounts.

Account.isEntitled

Determines whether or not an Account has an entitlement. This checks Account entitlements, as well as entitlements associated with the Account’s AutoBills.

Account.makePayment

Enters a payment against the Account.

Account.redeemGiftCard

Redeems a specified gift card and adds the corresponding credit to an Account.

Account.removeChildren

Removes a child or multiple children from a parent.

Account.reversePayment

Reverses an Account payment made using makePayment. This method may only be used with payments using MerchantAcceptedPayment payment methods.

Account.revokeCredit

Deducts a specified amount of credit from the Account.

Account.revokeEntitlement

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.

Account.stopAutoBilling

Cancels one or more AutoBill objects (subscriptions) associated with this Account object.

Account.tokenBalance

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.

Account.tokenTransaction

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.

Account.transfer

Merges the target Account with a given (source) Account, and returns the target Account with the merged content.

Account.transferCredit

Transfers credits from one Account to another.

Account.update

Creates or updates an Account object.

Account.updatePaymentMethod

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
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top