Skip to content

Bulk Importing Subscriptions

Instead of creating subscriptions one by one, you can import multiple subscriptions at once with a CSV file in the Finix Dashboard. During the import process, Finix provides a link to download a sample template (CSV) to help format your data.

Pre-requisites

  • You must have a subscription plan created before you can import subscriptions. At this time, you cannot import subscriptions without providing a subscription_plan_id.
  • You must have the identity_id and payment instrument_id for the subscriber.

Getting Started

  1. From the Subscriptions page, click the Add drop-down and select Bulk Import CSV.

    Add Bulk Import CSV
    • A Select Merchant Account popover displays.

  2. Select a Merchant Account.

  3. Click Proceed.

    • An Import Subscriptions page displays.
    Import Subscriptions Page

  4. Follow the instructions to prepare your subscription import file, including downloading the sample template (CSV) and filling in the fields.

CSV File Requirements

The following table shows the required and optional columns for importing subscriptions from an existing plan.

Currently, you can only import subscriptions that were created from subscription plans. For each subscription, you need to provide a subscription_plan_id.

Column NameTypeDescription
billing_overrides. collection_methodstring, optional
  • The method by which subscription payments are collected. Currently, automatically billing the card on file is the only method available.
  • Example: BILL_AUTOMATICALLY
billing_overrides. send_invoiceboolean, optional
  • Whether to send the user an invoice.
  • Example: true
billing_overrides. send_receiptboolean, optional
  • Whether to send the user a receipt.
  • Example: true
buyer_details. identity_idstring, required
  • The identity ID of the subscriber.
  • Example: IDtEnKsZyJNUGK83ZTx4C45S
buyer_details. instrument_idstring, required
  • The ID of the Payment Instrument from which the subscription payments get debited.
  • Example: PImXAVgkKVshKWWHUk4xXbve
buyer_details. requested_delivery_methods. email_destinationsstring, optional
  • Email address(es) where receipts should be sent. Multiple values may be separated by a semicolon.
  • Example: subscriber@example.com
buyer_details. requested_delivery_methods. sms_destinationsstring, optional
  • Phone number(s) where receipts should be sent via SMS. Multiple values may be separated by a semicolon.
  • Example: 2348765431
buyer_details. shipping_address. citystring, optional
  • City (max 20 characters).
  • Example: Middletown
buyer_details. shipping_address. countrystring, optional
  • 3-letter country code.
  • Example: USA
buyer_details. shipping_address. line1string, optional
  • First line of the address (max 35 characters).
  • Example: 324 Oak Avenue
buyer_details. shipping_address. line2string, optional
  • Second line of the address (max 35 characters).
  • Example: Apartment 7
buyer_details. shipping_address. postal_codestring, optional
  • Zip or Postal code (max 7 characters).
  • Example: 19734
buyer_details. shipping_address. regionstring, optional
  • 2-letter State code.
  • Example: DE
currencystring, required
  • ISO 4217 3-letter currency code. At this time, the only currencies supported are USD and CAD.
  • Example: USD
linked_tostring, required
  • The ID of the Merchant resource that you wish to link to the Subscription.
  • Example: MUxdJCr9xTMnmt1vGUAqV9z4
nicknamestring, optional
  • A human-readable name for the resource.
  • Example: Finflix Gold Package
start_subscription_atstring (date-time), optional
  • Indicates that the subscription is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing.
  • Example: 2025-05-05T22:42:05.490Z
subscription_details. notification_preferences. send_confirmationboolean, optional
  • Whether to send a confirmation email to the user.
  • Example: true
subscription_plan_idstring, required
  • The ID of the Subscription Plan from which to create the Subscription.
  • Example: subscription_plan_ctBbJ1ihsC8Hpju4RQfZE
total_billing_intervalsinteger, optional
  • The total number of billing intervals for the Subscription.
  • Example: 12

Uploading and Verifying Your File

  1. From the Import Subscriptions page, name your import file and upload the CSV file you filled out with your information.

  2. After uploading the file, click Verify File.

    • A Subscription Import page displays with an "Uploading and Verifying File" banner indicating the file is being verified.
    Subscription Import Page Verify File
Viewing Import Status

You don’t need to wait for the import to complete. You can leave and return later to check the status from the Subscription Imports tab on the main Subscriptions page.

If Verification Fails

If file verification fails, the banner title changes to "File Verification Failed" with a link to Download the verification errors (CSV) and the option to Upload a Corrected File.

If Verification Succeeds

If file verification succeeds, the banner title changes to "File Verified" to show your subscriptions were successfully verified.

A Confirm Import popover appears with a message showing how many subscriptions will be imported and asks if you want to proceed.

Subscription Import Page Confirm Import

Click Import Now to import all subscriptions in the file. The banner text updates to show the import is in progress.

When the import finishes, the banner text updates to show completion. It also provides an option to download CSV results.

Imported subscriptions now appear under Imported Subscriptions.

Subscription Import Page Import Complete

Viewing Your Imported Subscriptions

You can also view the imported subscriptions from the main Subscriptions page › Subscription Imports tab.

Subscription Imports Page Imported Subscriptions

This page is helpful to view the status of your subscription imports.