Migration Template for Bold Subscriptions

Alexa

Published: April 20, 2021 19:50

Last Updated: September 08, 2021 13:53

Bold Subscriptions
BigCommerce
No coding knowledge required
10+ Minutes

Overview

If you are interested in migrating your current subscribers to Bold Subscriptions on BigCommerce, please ensure that you have been approved by our Sales Team before requesting a migration.

Once you are ready to migrate to Bold Subscriptions, please download and complete the Bold Subscriptions Import Template. Our Migrations team will then review this information, and import it into your app.

It is important to note that both full and partial migrations cannot be performed without the help of our Migrations team. To fill out the form, please see our detailed explanation of the import template CSV columns below, as well as requirements before migrating.

Requirements Before Migrating

Before getting started with your migration, please follow these steps:

Install Bold Subscriptions on your BigCommerce store.
Fill out the Migrations Request Form.
Set up Bold Subscriptions. Please visit Setup Bold Subscriptions & Bold Checkout Integration for more information.

Note: Shipping must be properly configured on your store before continuing with the migration.
Create an account on the Bold Account Center. Please visit Create & Connect a Bold Account.

Our Migrations team will then contact you to provide any additional steps.

Customer Information

A - legacy_subscription_id

This information is required.

This is a unique subscription identifier used for grouping line items together. Upon performing an export from your current platform or app, this will likely be the alphanumeric set of characters representing the ID for the customer's overall subscription.

Note: It is recommended to double check this information to ensure these items are meant to be grouped together for an individual customer's subscription.

B - email

This information is required.

C - shipping_first_name

This information is required.

First name of the customer who will be receiving the subscription.

D - shipping_last_name

This information is required.

Last name of the customer who will be receiving the subscription.

E - shipping_company

This information is not required.

When your customers input a company name within the checkout, this information could be added here.

F - shipping_street1

This information is required.

Your customer's street address.

G - shipping_street2

This information is not required.

Your customer's apartment number, buzz code, or other information relative to the customer's street address.

H - shipping_city

This information is required.

Note:

City names must be written in full. Abbreviations will not be accepted.

IE. Winnipeg, Toronto, Chicago

I - shipping_province

This information only required if the shipping_province_code is not set.

Note:

Province and State names must be written in full. Abbreviations will not be accepted.

IE. Manitoba, Ontario, Illinois

J - shipping_country

This information is required.

Note:

Country names must be written in full. Abbreviations will not be accepted.

IE. Canada, United States

K - shipping_zip

This information is required.

Note:

If you are in the US and your zip code is 9 digits long, please put a dash in between.

IE. 64735-1234

L - shipping_province_code

This information is not required.

The abbreviated version of a province name.

IE. MB for Manitoba, AB for Alberta

M - shipping_phone

This information is required.

Note: The number must be without dashes.

IE. 2042222222

N - billing_first_name

This information is required.

O - billing_last_name

This information is required.

P - billing_company

This information is not required.

When your customers input a company name within the checkout, this information could be added here.

Q - billing_street1

This information is required.

R - billing_street2

This information is not required.

Your customer's apartment number, buzz code, or other information relative to the customer's street address.

S - billing_city

This information is required.

Note:

City names must be written in full. Abbreviations will not be accepted.

IE. Winnipeg, Toronto, Chicago

T - billing_province

This information is only required if billing_province_code is not set.

Note:

Province and State names must be written in full. Abbreviations will not be accepted.

IE. Manitoba, Ontario, Illinois

U - billing_country

This information is required.

Note:

Country names must be written in full. Abbreviations will not be accepted.

IE. Canada, United States

V - billing_zip

This information is required.

Note:

If you are in the US and your zip code is 9 digits long, please put a dash in between.

IE. 64735-1234

W - billing_province_code

This information is not required.

The abbreviated version of a province name.

IE. MB for Manitoba, AB for Alberta

X - billing_phone

This information is required.

Note: The number must be without dashes.

IE. 2042222222

Subscription Information

Y - gateway_name

This information is required.

This is the name of the payment gateway, such as Stripe or Authorize.net

Z - gateway_customer_id

This information is required.

This is the customer’s gateway customer ID from your payment gateway.

In Stripe, it is formatted as cus_a1b2c3d4e5f6g7h8
In Authorize.net, it is formatted as <Customer Profile ID>-<Payment Profile ID>

IE. 12345678-87654321

AA- gateway_payment_id

This information is not required.

This is the customer’s payment method token from your payment gateway.

In Stripe, it is formatted as card_a1b2c3d4e5f6g7h8 or pm_a1b2c3d4e5f6g7h8

AB - subscription_group_id

This information is required.

This is the Bold Subscriptions Subscription Group ID. This number can be found within the URL when editing a subscription group. This will link the subscription to the rules of the subscription group that the ID belongs to.

Note: Having a default subscription_group_id of zero is only possible for inactive subscriptions.

AC - subscription_status

This information is required.

Active - An active subscription that will generate orders moving forward.
Inactive - An archived & inactive subscription.
Paused - A subscription that is neither archived nor currently being processed.

AD - last_order_datetime

This is not required.

Note: This must be formatted in UTL (Coordinated Universal Time).

IE. YYYY-MM-DDT00:00:00Z

AE - next_order_datetime

This information is required.

This is the next date your customer should have an order generated.

Note: This must be formatted in UTL (Coordinated Universal Time).

IE. YYYY-MM-DDT00:00:00Z

AF - platform_product_id

This information is required.

The ID of the product on the destination platform that we will be subscribing your customers to.

Navigate to Orders, select View, then select Export ALL.
Select Default template.
Select Export.
Search for the Product Details column.

Please visit Importing & Exporting Products for more information.

AG - platform_variant_id

This information is required.

The ID of the product variant on the destination platform that we will be subscribing your customers to.

Within the BigCommerce admin, navigate to Advanced Settings > Storefront API playground.
Select the Paginate products tab.

Replace the payload on the right hand side with the following information:

# Get a few products from the catalog 
# Stores in pre-launch or maintenance mode may reject queries.
# Access from Control Panel > Advanced Settings > Storefront API Playground
# or browse privately and query against https://buybutton.store/graphql
query paginateProducts( 
 $pageSize: Int = 3
 $cursor: String 8
 # Use GraphQL variables to change the page size, or inject the endCursor as "cursor"
 # to go to the next page!
) {
 site {
 products (first: $pageSize, after:$cursor) {
 pageInfo {
 startCursor
 endCursor
 }
 edges {
 cursor
 node {
 # this entityId will be platform_product_id
 entityId
 name
 variants {
 edges {
 node {
 # this entityId will be platform_variant_id
 entityId
 # will need to cross reference SKU here
 sku
       }
     }
    }
   }
   }
  }
  }
}

Select the play button to run the query.

Note: This will return however many results pageSize is.

IE. if you have 10 products, the payload would display $pageSize: Int = 10)
Use the SKUs to map back to the product SKU found in the order export.

AH - order_rrule

This field is only required if no values were given for the interval fields below.

This value must include a DTSTART separated with a line break from the rest of the RRule.

A timezone (TZID) is encouraged, but when without, the subscription will be processed in UTC time.

          DTSTART;TZID=Europe/London:20190506T000000

          RRULE:FREQ=DAILY

AI - interval_number

This information is required if no values were given for order_rrule. This is the number of the frequency associated with the subscription.

1 week = 1
Every 15 days = 15
Every 3 months = 3

AJ - interval_type

This information is required if no values were given for order_rrule.

The subscription should be generated with the following frequency types: day, week, month, year

AK - price

This information is required.

Note:

The price must be greater than 0 and without decimals.

IE. 3523 instead of $35.23

AL - charged_currency

This information is required.

IE. CAD, USD, GBP

AM - base_to_charged_exchange_rate

This information is required.

The intended exchange rate between the shop’s base currency (see platform) and the charged_currency provided on the same row of the .CSV.

IE. A base to charged exchange rate between CAD (base) and USD (charged) is 0.79

AN - quantity

This information is required.

How many of a specific product a customer is subscribed to.

This should be greater than 0.

AO - is_prepaid

This information is required.

0 - A non-prepaid subscription
1 - A prepaid subscription

Note: Currently, prepaid subscriptions are not supported on Bold Subscriptions V2. This column should be marked as 0.

AP - prepaid_current_recurrence_count

This information is required for prepaid subscriptions.

The number of orders that have already passed in the current prepaid cycle.

Note: Currently, prepaid subscriptions are not supported on Bold Subscriptions V2. This column should be left blank.

AQ - prepaid_duration

This information is required for prepaid subscriptions.

The number of orders in a prepaid cycle.

Note: Currently, prepaid subscriptions are not supported on Bold Subscriptions V2. This column should be left blank.

AR - prepaid_continue_as

This information is required for prepaid subscriptions.

The expected behaviour when a customer's prepaid cycle ends.

no_continue - The subscription should immediately end when the last prepaid order is processed.
as_prepaid - The subscription should continue and be charged for another full prepaid cycle on the next order.
as_standard - The subscription should continue as a regular subscription and the next charge should only be for one order.

Note: Currently, prepaid subscriptions are not supported on Bold Subscriptions V2. This column should be marked as no_continue.

AS - placed_at

This information is not required.

The date the initial subscription was processed on.

IE. YYYY-MM-DDT00:00:00Z

AT - customer_notes

This information is not required.

A free-form note on a subscription's customer. This is applied as a note attribute to each order that is created on platforms that support customer note attributes.

AU - subscription_note

This information is not required.

A free-form note on a subscription orders. This is applied as a note attribute on platforms that support order note attributes.

Troubleshooting

Have questions about the migration process? We're here to help. Please contact our Merchant Success team.

Bold Subscriptions V2 Import Template.csv
(799 Bytes)