Migrate from Stay Ai to Bold Subscriptions for Shopify Checkout

Template Heading

Description

A - legacy_subscription_id

(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.

B - email

(required)

Your customer's email.

C - shipping_first_name

(required)

The first name of the customer who will be receiving the subscription.

D - shipping_last_name

(required)

The last name of the customer who will be receiving the subscription.

E - shipping_company

(not required)

If your customer has included a company name, this information could be added here.

F - shipping_street1

(required)

The street address of the customer who will be receiving the subscription. For example, 123 Main Street.

G - shipping_street2

(not required)

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

H - shipping_city

(required)

The name of the city where you will be shipping your customer's subscription.

Note: City names must be written in full. Abbreviations will not be accepted. For example, use Winnipeg, Toronto, or Chicago.

I - shipping_province

(required only if the shipping_province_code is not set.)

The name of the province or state where you will be shipping the subscription.

Note: Province and State names must be written in full. Abbreviations will not be accepted. For example, use Manitoba, Ontario, or Illinois.

J - shipping_province_code

(not required)

This is the abbreviated version of a province or state name. For example, MB for Manitoba, or AB for Alberta.

K - shipping_country

(required)

The name of the country where you will be shipping the subscription.

Note: Country names must be written in full. Abbreviations will not be accepted. For example, use Canada, or United States.

L - shipping_zip

(required)

This is the zip code or postal code of your customer's shipping address.

Note: If you are in the US and your zip code is 9 digits long, please put a dash in between. For example, 64735-1234.

M - shipping_phone

(required)

The phone number of the customer who will be receiving the subscription.

Note: The number must be without dashes. For example, 2045556575.

N - billing_first_name

(required)

The first name of the customer who is being billed for the subscription.

O - billing_last_name

(required)

The last name of the customer who is being billed for the subscription.

P - billing_company

(not required)

If your customer has included a company name, this information could be added here.

Q - billing_street1

(required)

The street address of the customer who is being billed for the subscription.

R - billing_street2

(not required)

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

S - billing_city

(required)

The city the customer who is being billed for the subscription resides in.

T - billing_province

(required only if the billing_province_code is not set)

The province or state of the customer who is being billed for the subscription.

Note: Province and state names must be written in full. Abbreviations will not be accepted. For example, use Manitoba, Ontario, or Illinois.

U - billing_province_code

(not required)

This is the abbreviated version of a province or state name. For example, MB for Manitoba, or AB for Alberta.

V - billing_country

(required)

The name of the country which the customer who is being billed for the subscription resides in.

Note: Country names must be written in full. Abbreviations will not be accepted. For example, use Canada, or United States.

W - billing_zip

(required)

The zip or postal code of the customer who is being billed for the subscription.

Note: If you are in the US and your zip code is 9 digits long, please put a dash in between. For example, 64735-1234.

X - billing_phone

(required)

The phone number of the customer who is being billed for the subscription.

Note: The number must be without dashes. For example, 2045555657.

Y - gateway_name

(required)

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

gateway_customer_id

(required)

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

For more information on how to format the gateway_customer_id relevant to your payment gateway, please view the example below based on the checkout you will be using.

• Payment Gateway	Gateway Name	Format
  Shopify Payments  (Stripe)	Stripe	Use the Customer ID. For example, cus_a1b2c3d4e5f6g7h8.
  Shopify Payments  (Shopify Payment method)	Shopify	Use the payment method ID. For example,  gid://shopify/CustomerPaymentMethod/2342d6ff8f8338998c6e027099c79ace
  PayPal Express	PayPal	Use the billing agreement ID. For example, B-1A2B3C4D5E6F7G8H
  Authorize.net	Authorize.net	Use the billing agreement ID. For example, 12345678

• Payment Gateway	Gateway Name	Format
  Stripe	Stripe Default	Use the Stripe customer ID. For example, cus_a1b2c3d4e5f6g7h8
  Braintree	Braintree Credit Card	Use the payment method ID.  For example, 6gbkd76
  Braintree PayPal	Braintree Paypal	Use the Braintree PaymentMethod.legacyId  For example, 94w7ycr
  Authorize.net	Authorize.net	Use the format <Customer Profile ID>-<Payment Profile ID>  For example, 12345678-87654321
  Amazon Pay	Amazon Pay	Use the chargePersmissionId or AmazonBillingAgreementId  For example, C04-1234567-7654321

AA - gateway_payment_id

(not required)

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

• In Stripe on Shopify Checkout, the ID is formatted as: pm_a1b2c3d4e5f6g7h8 or card_a1b2c3d4e5f6g7h8
• In Authorize.Net on Shopify Checkout, the ID is formatted as: 87654321

Note: This can be supplied for either Authorize.net or Stripe when a specific payment ID is available. If it is not supplied, then the customer's default source (default card) will be used.

AB - subscription_group_id

(required)

This is the Bold Subscriptions Subscription Group ID.

This number can be found in the app admin under Subscription Groups, in the Name column. This will link the subscription to the rules of the subscription group that the ID belongs to.

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

AC - subscription_status

(required)

The statuses are:

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

AD - last_order_datetime

(not required)

This is the date your customer had their last order generated.

Note: This must be formatted in UTC (Coordinated Universal Time). For example, YYYY-MM-DDT00:00:00Z

AE - next_order_datetime

(required)

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

Note: This must be formatted in UTC (Coordinated Universal Time). For example, YYYY-MM-DDT00:00:00Z

AF - platform_product_id

(required)

This is the ID of the product on the destination platform that your customer needs to be subscribed to.

This can be found when editing the product in Shopify, within your web browser's address bar at the end of the URL. 

For example, the product ID is 4457088254016 in the screenshot below.

AG - platform_variant_id

(required)

This is the ID of the product variant on the destination platform that your customer needs to be subscribed to.

This can be found when editing a specific variant in Shopify, within your web browser's address bar at the end of the URL.

1. Find the product variant, then select Edit.
2. Find the ID within your web browser's address bar (at the end of the URL).

For example, the variant ID is 31689213902912 in the screenshot below.

Note: If your product doesn't have variants, you can find this information within the Shopify admin of your product. Navigate to the page of the product within your Shopify admin, then enter .json or .xml at the end of the URL. This will take you to a webpage that will display the default variant ID information. See the example below.

AH - order_rrule

(required only if no values are given for the interval_number below.)

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

For example:

DTSTART;TZID=Europe/London:20190506T000000
RRULE:FREQ=DAILY

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

AI - interval_number

(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

(required if no values were given for order_rrule)

This is the frequency type for the subscription.

For example: day, week, month, year.

AK - price

(required)

The price is the cost of an individual subscription product.

The price must be greater than 0 and without decimals. For example, use 3523 instead of $35.23

Note: If your customers are subscribed to more than 1 subscription product, the price must still be entered as only 1 subscription product.

AL - charged_currency

(required)

This is the currency your customer has been charged in.

For example, CAD, USD, or GBP.

AM - base_to_charged_exchange_rate

(required)

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

For example, a base to charged exchange rate between CAD (base) and USD (charged) is 0.79.

AN - quantity

(required)

This is the quantity of a specific product that your customer is subscribed to.

This should be greater than zero.

AO - is_prepaid

(required)

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

AP - prepaid_current_recurrence_count

(required for prepaid subscriptions)

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

AQ - prepaid_duration

(required for prepaid subscriptions)

This is the number of orders in a prepaid cycle.

AR - prepaid_continue_as

(required for prepaid subscriptions)

This is 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.

AS - placed_at

(only required if needed)

This is the date the initial subscription was processed on.

This should be formatted as YYYY-MM-DDT00:00:00Z.

AT - subscription_note

(only required if needed)

These are any notes about the subscription. The note is visible in the Bold Subscriptions admin and is applied as a note attribute on supported platforms.

AU - customer_notes

(only required if needed)

These are internal notes about the customer. This is applied as a note in the Customer info section of the Bold Subscriptions admin.

AV - subscription_group_billing_rules_id

(only required if needed)

This ID is used by Bold Subscriptions to show frequency names in both the admin and Customer Portal.

You can find this in the Bold Subscriptions admin when editing your subscription group, next to Subscription frequency.

Note: This is recommended for stores with highly customized Customer Portals.

AW - discount_code

(only required if needed)

Any discount codes for your subscribers must be set up in Shopify before performing the import.

Discount codes are case sensitive. Please enter your discount code exactly as it appears within Shopify.

For example, SPRINGSALE, SAVE10, DiscountCode15.