Skip to main content
Vindicia Knowledge Center

Creating Accounts

Creating Accounts

Click the Create Account link from the Account Search or List page to open the Create Customer Account page, and create a new Account.


Create Customer Account Page

1. Complete the fields as described in the Vindicia Subscribe Account Parameters table.

  • Click Merchant Data to enter custom data for the Account. (For more information, see Working with Custom Data.)
  • Click Sales Tax Exemptions to add tax exemptions for the Account. For more information, see Adding and Editing Sales Tax Exemptions.
  • Click Add Payment Method to add a Payment Method to the Account.

For more information, see Adding and Editing Payment Methods.

2.  Click Submit to create the new Account, and return to the Account Search page.

Working with Custom Data

Custom Data allows you to create and add customized information to your Vindicia Subscribe system.

Note In the Vindicia Subscribe UI, some instances of this field are titled Custom object Data, and some are titled Merchant Data.

Custom Data is stored in Vindicia Subscribe as a pair of matched text strings, called name-value pairs. You may assign custom data to Billing Plans, Products, AutoBills, Accounts, and Tokens, each of which is associated with its own Custom Data list. For each of these objects, Vindicia Subscribe stores a list of Names, which may be associated with text string Values. Use name-value pairs to help categorize or sort aspects of your system. Both the name and the value components of a name-value pair are limited to 255 characters each. If you create a custom name-value pair in which one or both components exceeds the 255 character limit, Vindicia Subscribe will return a 400-series error/return code, to ensure that your data is not lost without warning.

Tip Use Name to define a category, and Value to define a specific item in that category. For instance, name-value pairs might be used to track your sales teams. Define a name-value pair withName = “Office,” and Value equal to the city in which the office is located. Define a second name-value pair with Name = “Salesman,” and Value the name of specific salesmen. Assign name-value pairs Office-Chicago and Salesman-JSummers to Billing Plans to sort or search those plans both by the office in which they originated, and the salesman responsible for the account.

Click Custom Data to open the pane, and view, remove, or edit custom data associated with the Vindicia Subscribe Product, Billing Plan, AutoBill, Account, or Token.

The pane will list all Name-Value pairs associated with the specific Vindicia Subscribe object.

If there is no Custom Data associated with the Vindicia Subscribe object, the pane displays only the Add New Data button. Click this button to add Custom Data, as desired.

Merchant Data Pane

To add a new name-value pair:

  • Click Add New Data.
  • Use the Name pulldown menu to select an existing Name for the pair, or select New Name from the menu to open a field in which a new Name may be entered.
  • Enter the desired text string for the pair in the Value field.

Note For pages which list Merchant Data rather than Custom object Data, the Name pulldown menu is not available, and the Name value must be entered manually.

To change the Value associated with the name-value pair, simply edit the Value text field.

Note Vindicia Subscribe allows only one value per name per object. Name-value pairs (custom data) may have several values associated with eachname, but only one value may be used for a given name-value pair associated with an individual Vindicia Subscribe object.

To delete a name-value pair assigned to the Account, click Delete to the right of the name-value pair.

Note Delete removes the name-value pair from the Account, but does not delete the pair from your Vindicia Subscribe system.

Adding and Editing Sales Tax Exemptions

Tax Exemptions define the exemptions associated with a Customer Account.

If an Account has tax exemptions associated with it, the Account Details Page will include a Sales Tax Exemptions... link. (If no exemptions are on file for the Account, the link will not be included in the page.) Click this link to view tax exemption information for the Account.

Customers may provide you with tax exemption information that includes Tax Exemption ID, Jurisdiction (Country), Start Date, and End Date. If a customer with a tax exemption purchases a product that is ordinarily taxable, the tax will not be calculated. Merchants may enter tax exempt information in Accounts, and mark Accounts as tax exempt. Vindicia Subscribe will automatically take this information into account when calculating billing totals.

1. Click the Sales Tax Exemptions... link to open or close the Sales Tax Exemptions pane.

Sales Tax Exemptions Pane

2. Enter changes in the fields provided for an existing Exemption. (For more information, see Tax Exemption Fields.)

3. Click Delete Exemption to delete an exemption. Tax Exemptions may not be deactivated. To remove an Exemption from an Account you must delete it.

4. Click Add Exemption to add more exemptions.

5. Click Submit to save your changes.

The following table describes the available Tax Exemption fields.




Tax Exemption Code

Displays the tax exemption ID code, provided by the Account holder.


Specifies the country of jurisdiction for the tax exemption.

Start Date

Indicates the starting date that the tax exemption commences.

Stop Date

Indicates the projected ending date for the tax exemption, usually the date by which the owner of the Account must renew the tax exempt status.


Adding and Editing Payment Methods

Payment Methods define the way by which an Account pays for their AutoBills. Accounts may have several Payment methods associated with them, which are listed in order of preference. The first Payment Method listed for the Account is the Account’s default payment method.

The Payment Method panes for an Account list the associated Payment Methods for the Account. These may be Credit Card, ECP, Direct Debit, Boleto, or Pay by Invoice. The Payment Type field lists the method as a link. For example, see the Account Details Page (CreditCard Payment Method). Click the link to view all Transactions associated with this credit card.

Payment Methods may be added to Accounts both as part of Account creation, and when editing the Account.

When you edit an Account, Vindicia Subscribe edits the existing Payment Method.

  • If the merchantPaymentMethod of an existing Payment Method is passed, then that Payment Method is edited. If replaceOnAllAutoBills is false, this edit is applied to all AutoBills using that Payment Method, and no other.
  • If a new merchantPaymentMethodId is passed, then a new Payment Method is created. If replaceOnallAutoBills is false, then the new Payment Method will not be applied to any autoBills. If it is true, it will be applied to all.

To add a new Payment Method to an Account:

1. Click Add Payment Method from the Create or Edit Customer Account page.

(Only currency Payment Methods may be added to an account through the Edit Customer Account page. To add Tokens as a Payment Type, go to Manage > Vindicia Subscribe > Tokens, and click Create New Token.)



Add Payment Method Pane

2. Select a Payment Type:

  • CreditCard
  • Military Star
  • ECP
  • DirectDebit
  • Boleto
  • Pay by Invoice
  • Carrier Billing

The fields listed for a Payment Method vary by Payment Type, and will update automatically when a new Payment Type is selected.

3. Select Active: Yes to allow the Payment Type to be used for Payments. Select Active: No to save the Payment Method, but deactivate it for use in future AutoBills.

4. Use the Move Up and Move Down buttons to re-order multiple Payment Methods. Payment Methods will be applied to AutoBills, by default, in the order in which they are listed on the Account.

5. Use the Delete button to delete unwanted or inaccurate Payment Methods.

6. Click Merchant Data to add new name/value pairs to the Payment Method. These may be used to sort or search your Payment Methods, or any Account or AutoBill associated with them.

7. Click Submit to save your changes, or Cancel to discard them.

The following table describes Vindicia Subscribe Payment Method parameters.



Payment Method (n)

Lists a payment method associated with the Account. An Account may have one or more Payment Methods, each listed in its own pane, and numbered sequentially, where (n) indicates the order of payment method preference.

Payment Type

Indicates the Payment Method used on the Account. This field is required. Valid types include:

  • CreditCard
  • ECP
  • DirectDebit
  • Boleto
  • Pay by Invoice
  • PayPal
  • Skrill
  • Token
  • Carrier Billing

The Payment Method Types listed depend both on your Vindicia Subscribe configuration, and the Payment Methods supported by your payment processor(s).

Descriptive fields vary depending on the specified Payment Method Type.

Account Holder

Optional. The payee name associated with this payment method.

Billing Profile ID

Displays the merchant’s unique ID associated with the Billing Profile for this Account.

Customer Specified Type

Optional. The Credit Card type supplied by the customer.

Customer Specified Description

Optional. The payment method description supplied by the customer.

All AutoBills Shall Use This Method

Select Yes to apply this Payment Method to all AutoBills for the Account. Default is No.

Merchant Specified Type

Optional. Payment Type information for a Pay by Invoice Payment Method.

Credit Card Number

Displays the blinded credit card number used for this payment method. Only the first 6 and last 4 digits of this number are displayed.

Credit Card Expiration

The expiration date of the credit card.

(ECP) Account Type

Indicates the type of bank Account used for ECP. Valid types include:

  • Consumer Checking
  • Consumer Savings
  • Corporate Checking

(ECP) Transaction Type

Indicates the types of Transactions supported. Valid values are:

  • Inbound: funds may be debited from the Account (to merchant).
  • Outbound: funds may be credited to the Account (from merchant).
  • InboundOutbound: funds may be debited from or credited to the Account.
  • Transfer: funds may be transferred between two Accounts (non-merchant Accounts).

(ECP) Routing Number

Displays the Bank Routing Number.

(ECP) Account Number

Displays the last four digits of the Bank Account Number.

When an Account is first created, the entire bank account number is entered, then hashed, securely sent, and stored in the Vindicia Subscribe system. Thereafter, only the last 4 digits are displayed.

(Boleto) Fiscal Number

Displays the last four digits of the customer registration (CPF/CNPJ).

EDD Bank Sort Code

Displays the last four digits of the bank sort code.

When an Account is first created, the entire bank sort code is entered, then hashed, securely sent, and stored in the Vindicia Subscribe system. Thereafter, only the last 4 digits are displayed.

Token Type

The kind of Token used for payment.

Token Description

The description of the Token Type used for payment.

Token Balance

Displays the current balance for the Token Type used for payment.

Billing Address

Optional. Billing address information for the customer.

Although this field is optional in Vindicia Subscribe, you may require parts of the address for processing and to calculate applicable taxes. Merchants who charge taxes typically use the address information provided in the Shipping Address field for tax calculation, because that location is most likely where the Product will be used. If a Shipping Address is not provided, the Billing Address associated with the Payment Method is used instead.

(Carrier Billing) Phone Number

Optional. The customer Phone number used for the payment.

(Carrier Billing) Payment Provider

The Payment Provider selected for the Transaction. (Vindicia Subscribe currently supports BOKU.)

(Carrier Billing) Currency

ISO 4217 Currency Code for either the static_price_inc_salestax, or the dynamic_target_price. (For dynamic pricing, the customer currency will be determined by the customer region/countryCode.)

(Carrier Billing) Country

The country for the customer’s location.

(Carrier Billing) Encoded Phone Number

Read only. The Payment Provider-encoded phone number used in the Transaction.

Vindicia Subscribe Features

Learn More
Vindicia Subscribe Features

For Developers

Learn More
For Developers
Back to Top