Your unique identifier for this customer.
An optional new unique ID you can use (create) in place of the merchantAccountId, or in conjunction with it by mapping the merchantAccountId to your merchant-facing Interface, and the externalId to your external billing system.
Best Practice is to use this field when you have two external (non-Subscribe) systems using two different identification schemes for the same customer. Note that the externalId is enforced to be unique or null in the Vindicia system. Attempting to create an Account with the existing externalId returns Failed to update Account with no specific error.
Customer’s full name.
Date of account creation.
Name of the company the customer is associated with.
Email address associated with the account. If provided, the email address is used by CashBox to send billing notifications.
Format of email notifications sent to the customer.
Email Before BillingEmail address to which pre-billing notifications will be sent to notify account holder prior to automatic subscription period renewal.
Two- or three-character IANA sub-tag registry standard language code corresponding to languages that have been loaded by the merchant into the system. CashBox uses this setting to determine which of its email templates to use when sending notification message to the customer.
Note: Although CashBox supports both ISO 639 and IANA language codes, Vindicia recommends using IANA codes.
ISO-4217 three letter format of the default currency used in customer transactions. Currency code, _VT represents CashBox Tokens.
The currency you specify here becomes the default currency CashBox uses when you pass in a one-time transaction or subscription without specifying a currency. Or you can request Client Technical Support to define a global default currency. If you choose neither of these options (and do not specify a currency when you pass in a one time Transaction or Subscription without specifying a currency) CashBox defaults to USD.
When you do not specify a currency, CashBox determines the currency to use by proceeding from the specific to the general, in the following order:
- Global (merchant) default
- Vindicia default
If you specify a currency for a transaction or subscription, CashBox always uses that code. Defaults are applied only when no currency code is specified.
Because one-time transactions have no associated subscription, if you create a new Transaction without specifying a currency, CashBox uses the default Currency of the Account. If there is none set in Account, CashBox uses the Global default. If no global default is set, CashBox defaults to USD.
Used for shipping a product to the customer but can also be used in the calculation of applicable taxes. Merchants who charge taxes typically use the shipping address as the first choice because that is likely the location where the product will be used. If a shipping address is not provided, the billing address associated with the payment method is used.
Tax Use Code
Customer account-level tax exemption code. Overrides any individual exemptions defined for the account and instructs the tax engine to tax according to the matching predefined taxability profile (usually fully or partially tax exempt).
If this is a child account the parent is listed here. If this is a child account it cannot have any children.
Current amount due on customer account.
Amount that is overdue from previous billing periods.
Token balances on the account.
Number of subscriptions on the account.
Number of transactions processed on the account.
The number of accounts that are child accounts and how many subscriptions on those child accounts this account is responsible for. Click on a child account for details.