Token object represents a metering or virtual-currency unit of a specific type, and may be used to support billing models that use arbitrary tracking units with tokens and related objects in the Subscribe API. The units are of your own choosing and may be minutes, downloads, incentive points, virtual currency, storage space, number of users, or any other imaginable unit. In the Subscribe API, those units are represented by a generic Token object. Tokens allow you to define token types, and associate them with a customer Account. Tokens may be purchased, granted, decremented, or refunded, and you may retrieve Token balances for customer Accounts.
Note: Use of the forward slash character (/) in merchant identifiers is not allowed. See Merchant Identifiers for more information.
The following table describes the three token-related objects.
You may define any number of Tokens, and can manage each customer’s associated balance of units by granting (incrementing), and decrementing Token counts through Products, Billing Plans, or AutoBills.
Token Transactions pass through the Subscribe Token Processor, and appear as Transactions in all applicable Subscribe Portal pages, including generated Reports.