Complete the following fields as appropriate.
Your unique identifier for this Account.
(Use of the forward slash character (/) in merchant identifiers is not allowed.)
Customer’s full name—typically corresponds to the name associated with the payment method on the account, but is not required.
Name of the company the customer is associated with.
Email address associated with this account. If provided, the email address is used by Subscribe to send billing notifications. While providing a value in this fields is not required, you might require it for your records.
Format of email notifications sent to the customer. Select an Option:
- html—email is sent in HTML format
- plaintext—text is sent as plain text
Email Before Billing
Yes/No. Indicates whether to send pre-billing notifications to the customer prior to automatic subscription-period renewal.
This setting only affects pre-billing notifications in Subscribe. Other notifications, for example, Success, Expiration, and failure messages, are independent of this setting.
Two- or three-character IANA sub-tag registry standard language code corresponding to languages that have been loaded by the merchant into the system. Subscribe
uses this setting to determine which of its email templates to use when sending notification message to the customer.
Note: Although Subscribe 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 Subscribe Tokens.
The currency you specify here becomes the default currency Subscribe uses when you pass in a one time Transaction or Subscription without specifying a currency. Or you can request Client Services 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) Subscribe uses the Vindicia default, which is USD.
When you do not specify a currency, Subscribe determines the currency to use by proceeding from the specific to the general, in the following order:
4. Global (merchant) default
5. Vindicia default
If you specify a currency for a Transaction or Subscription, Subscribe 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, Subscribe uses the default currency of the account. If there is none set in account, Subscribe uses the global default. If no Global default is set, Subscribe applies the Vindicia default, which is USD.
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).
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.
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 the location where the product will most likely be used. If a shipping address is not provided, the billing address associated with the payment method is used for tax calculation.