Recurring Invoices Import – SubscriptionFlow

To import recurring invoices attached to subscriptions, you must first have Customers, Products & Plans set up prior. In the case of subscription-based recurring invoices, you must also have Subscriptions tied to these invoices imported.

Sample File:

Recurring Invoices Sample File

Step 1: File Preparation

First, prepare your file for import. You can use any spreadsheet software but you must export the file to CSV format in the end. The following columns/fields are required for the successful import of invoices.

Mandatory Fields

System Field Names	Description	Sample Data
*Invoice*
Customer id*	A unique identifier tying an invoice to a specific customer	210a8e64-0ac8-46bf-a246-8428def12c89
status*	The payment status of the invoice in the system. Accepted values are “due,” “overdue,” “paid,” “partially paid.” “void,” & “projected”.	Due
total_amount*	The total payable amount linked to the invoices.	300
*Line Items*
Plan id*	A unique identifier tying an invoice to a specific plan	1f1e5c19-ce76-40c6-8b75-43b77cc4e871
Product id*	A unique identifier tying an invoice to a specific product.	89ab920a-8e63-425c-99fe-7230a316802e
subscription_id*	A unique identifier for the subscription being invoiced, only in the case of subscription based recurring invoices.	31232b1c-bb4b-40a8-b4c1-4d2e64dbf440
*Charges*
List Price*	A numeric value stating the price of goods being sold.	25
Quantity*	A numeric value quantifying the units utilized during the billing period.	3
service_from*	The start date of the billing period.	5/25/2023
service_to*	The last day of the billing period.	6/24/2023

Some additional fields programmed into the system may also be imported.

Optional Fields

System Field Names	Description	Sample Data
*Invoice*
id	A unique identifier for the invoice	ab4422af-890d-4fde-b2e1-192b25338bbd
currency	The currency charges are listed in	USD
status_reason	The reason for the invoice payment status	Missing default payment method
invoice_date	The date the invoice was generated	01/03/2024
due_date	The date the invoice is due	05/03/2024
received_payment	Payment collected against this invoice	50
discount	A numeric amount subtracted from the total charge.	0
total_tax	A numeric value defining the tax collected	0
is_one_off	True or false to whether this is a one-off invoice or not	1
*Line Items*
coupon	The id or coupon code associated with this line item
*Charges*
plan_price_id	A unique identifier to the charge id within a plan (as a plan may have multiple charges)	31232b1c-bb4b-40a8-b4c1-4d2e64dbf440

Step 2: File Upload

Click on Invoices in the toggle navigation bar on the left-hand corner of the dashboard.

On the Invoices page, click on the Import button in the top right-hand corner.

You’ll be taken to the Invoices Import page. Here under the question: Which type of Invoices you are going to import?, select Subscription-Based Recurring Invoices. Then click on the ‘Start Import’ button.

On the IMPORT page, use the Browse Files button to upload your CSV file. After uploading your file click Next to proceed.

Step 3: Field Mapping

You will now enter the field mapping screen. Here the system has automatically mapped all the mandatory fields from the import file to the fields in SubscriptionFlow. Hover on the ‘i’ next to any SubscriptionFlow Property for an explanation.

Map any unassigned fields using the drop-down menu.

Step 4: Advanced Configurations

Select the date and time format if any dates were included in the file. This is an important step as your import may fail if the date format in the file does not match this selection.

Click on Advance Settings to configure import settings. Select Update existing to update any repeat records based on the criterion selected from the drop-down. For example, if two invoices are found with the same invoice id, the system will update the data to the most up-to-date information.