Subscription File Formatting

Subscription files must be carefully formatted. Any omission of required data or inaccuracy in field order might result in errors and prevent the file from being uploaded.

When submitting a plain text subscription file, fields must be separated using a comma (,) delimiting character and quotation marks (") for the encapsulation character. Or, you can click here to download a Microsoft Excel (.xls) subscription file template. All you have to do is import subscription data into the Excel template, save the file in the .csv (comma delimited) format, and you're ready to submit the file.

IMPORTANT: Regardless of payment method, ALL fields listed below must be represented in a subscription file. Data does not need to be present for fields that are optional or not required; however, these fields should be blank spaces that are properly encapsulated and delimited (see the sample subscriptions below). This is necessary so that the payment gateway can correctly read the information.

ORDER	FIELD NAME	REQUIREMENTS	LENGTH	DESCRIPTION
1	Subscription Name	Optional	20	Merchant-assigned name for the subscription.
2	Invoice Number	Optional	20	The Invoice Number will repeat for each subsequent recurring transaction.
3	Description	Optional	255	A description of the subscription.
4	Amount	Required	15	The amount to be billed to the customer each time the transaction is submitted. If a trial period is specified, this is the amount that will be billed after the trial billing occurrences are completed. Must be a valid amount.
5	Payment Method	Required	CC, ECHECK	If blank, the default Payment Method is CC.
6	Credit Card Number	Required only if Payment Method = CC	22	Must be a numeric value.
7	Credit Card Expiration Date	Required only if Payment Method = CC	MMYY, MMYYYY
8	Bank Account Type	Required only if Payment Method = ECHECK	CHECKING, BUSINESSCHECKING, or SAVINGS	If blank, the default Account Type is CHECKING.
9	ABA Routing Number	Required only if Payment Method = ECHECK	9	Must be a valid 9-digit ABA Routing Number.
10	Bank Account Number	Required only if Payment Method = ECHECK	20	Must be a numeric value.
11	Name on Account	Required only if Payment Method = ECHECK	22	The full name of the individual associated with the bank account number provided.
12	Bank Name	Required only if Payment Method = ECHECK	50	The name of the financial institution associated with the provided bank account number.
13	Start Date	Required	MM/DD/YY	The date the subscription begins (also the date the initial billing occurs).
14	Total Occurrences	Required	4	Must be a numeric value. To indicate a subscription with no end date (an ongoing subscription), this field must be submitted with a value of "9999." If a trial period is specified, this number should include the trial occurrences.
15	Interval Length	Required	If the Interval Unit is "Month," can only be 1, 2, 3, 6, 12. If the Interval Unit is "Day," can be any number between seven (7) and 365.	The measurement of time between each billing occurrence based on the Interval Unit. For example, an Interval Length of "2" with an Interval Unit of "Month" would result in a billing every other month for the duration of the subscription. The day of the month that the billing occurs is dictated by the start date.
16	Interval Unit	Required	Month, Day	The unit of time, in association with the Interval Length, that is used to define the frequency of the billing occurrences.
17	Trial Occurrences	Optional	2	Must be a numeric value. This number should be included in Total Occurrences.
18	Trial Amount	Required only if a value is provided for Trial Occurrences.	15	The amount to be charged for each billing during the trial period. After the trial period has completed, the amount indicated in the Amount field will be charged for remaining billing occurrences.
19	Customer ID	Optional	20	Merchant-assigned identifier for the customer.
20	Customer Type	Required only if Payment Method = ECHECK	I = Individual B = Business
21	Billing First Name	Required	50
22	Billing Last Name	Required	50
23	Billing Company	Optional	50
24	Billing Address	Optional	50
25	Billing City	Optional	40
26	Billing State	Optional	40
27	Billing ZIP Code	Optional	20
28	Billing Country	Optional	60	Must be a valid two-character country code or full country name (spelled in English).
29	Customer Phone	Optional	25
30	Customer Fax	Optional	25
31	Customer Email	Optional	255
32	Shipping First Name	Optional	50
33	Shipping Last Name	Optional	50
34	Shipping Company	Optional	50
35	Shipping Address	Optional	60
36	Shipping City	Optional	40
37	Shipping State	Optional	40
38	Shipping ZIP Code	Optional	20
39	Shipping Country	Optional	60	Must be a valid two-character country code or full country name (spelled in English).
40	Customer Tax ID/Social Security Number	Optional	9	Must be a valid 9-digit Tax ID or Social Security Number with no hyphens.
41	Driver's License Number	Optional	50
42	Driver's License State	Optional	2	Must be a valid two-character state code.
43	Driver's License Date of Birth (DOB)	Optional	YYYY-MM-DD, YYYY/MM/DD, MM/DD/YYYY, MM-DD-YYYY
44	eCheck.Net Type	Required only if Payment Method = ECHECK	CCD , PPD , WEB	If blank, when Bank Account Type is Checking or Savings, the default eCheck.Net Type is WEB. When Bank Account Type is Business Checking, the default eCheck.Net Type is CCD.

Sample Subscriptions

Sample Credit Card Subscription

Sample 1 Subscription,Invoice1,This is a sample credit card subscription,10.00,CC, 0000000000000000,0706,,,,,,03/01/06,3,1,Month,,,Customer ID,,Jane,Doe,,,,,,,,,,,,,,,,,,,,,,,

Sample eCheck.Net Subscription

Sample 2 Subscription,Invoice2,This is a sample eCheck subscription,

8.00,ECHECK,:,,CHECKING,000000000,000000000000,Jane Doe,

First Bank,08/01/06,12,1,Month,,,43267,,Jane,Doe,,,,,,,,,,,,,,

,,,,,,,,WEB