Bulk managing subscriptions
Subscription properties, such as price, product title, subscription frequency, etc., can be easily updated using the merchant portal’s bulk management tools. This guide provides instructions for performing the different subscription management bulk update types.
Before you start
- Store owners have account permissions to use bulk management tools by default. Store owners can grant permissions to other staff members from the accounts page.
- This guide provides instructions for bulk updating subscription properties. For guidance on bulk updating charge dates, see Bulk managing charges.
Bulk update types
Several types of bulk updates can be done from the merchant portal. Refer to the following table for an overview of each bulk update type:
Update type |
Summary |
|
Reschedule |
This update type reschedules a single subscription. If an order contains multiple line items that are subscription products, this update only updates one line item. This may be useful for updating specific subscription items when a product is out of stock or discontinued. If you would like to reschedule the entire charge and all line items associated, see Bulk managing charges. |
|
Swap product |
This update type swaps subscription products. Note: For Recharge Checkout on BigCommerce stores, variant IDs are needed to perform a product swap with the Import tool. See Finding and exporting BigCommerce product and variant IDs for more information. |
|
Update status |
This update type changes the status of the subscription. Status options include:
|
|
Edit properties |
This update type changes specific subscription properties. The following properties can be updated using this type:
Note: Refer to the bulk update types table for the specific column titles to use for your bulk update. |
|
Delete subscriptions |
Permanently delete subscriptions from your store. subscription_id is the only column required to complete this update. |
Update subscriptions using the Multi-select tool
The Multi-select tool allows you to update subscriptions based on search criteria or filter options. The Multi-select tool is built into the merchant portal and provides an easy-to-use interface with selection boxes.
Step 1 - Prepare the bulk update
To start a bulk update using the Multi-select tool, search for and select subscriptions to update:
- In the merchant portal, click Subscriptions. On the Subscriptions page, search for relevant subscriptions by using the search criteria or filter options.
- Use the selection boxes to select individual records or select all records to update all search results.
- Click Actions and choose a bulk update type.
- Add the new value for the update type and select Next.
- Preview the update summary and select Prepare update. Recharge will generate your update file and email you when the update is ready for processing.
Step 2 - Perform the bulk update
The bulk update file will generate in the background, and you can check the status at any time:
- In the merchant portal, click Data and select Bulk updates to view your validated files.
- Click Process update to begin the bulk update.
- On the pop-up modal, click Update subscriptions to confirm the bulk update.
- Once the update is done, the Processing status will be marked Complete, and the Results will display the number of subscriptions updated.
- From the merchant portal, click Subscriptions to confirm the updated information is correct.
Update subscriptions using the Import tool
The Import tool utilizes CSV files to perform multiple update types independent of search criteria or filters. The CSV file used by the Import tool can be customized to include many different subscription property updates in one bulk update request.
Step 1 - Prepare CSV file
To use the Import tool, you must prepare a CSV file:
- In the merchant portal, click Data and select Exports.
- Create an export using the Subscriptions option from the drop-down list.
- After processing the export, download and open the export.
- Depending on the update type you are performing, you will need to add specific properties to your CSV file. The following table is split into the different bulk update types and lists the columns required for the update. Add columns to the CSV file using the applicable properties for your bulk update type:
Note: Ensure you delete the columns you do not need on your CSV file, or the import may fail and return errors.
COLUMN TITLE |
SUMMARY |
ALL BULK UPDATE TYPES |
|
|---|---|
|
address_id |
The numerical Address ID associated with a customer’s subscription. If you need to find Address IDs in Recharge:
This column is optional for all bulk update types except discount and address updates. |
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
CHARGE FREQUENCY AND INTERVAL UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
charge_interval_frequency |
The numerical value of how often the product is charged depending on what is configured in the ruleset. For example, if a product were configured to charge every three months, the value here would be three. Required when passing order_interval_unit. |
|
order_interval_frequency |
The numerical value of how often the product is shipped depending on what is configured in the ruleset. For example, if a product were configured to ship every month, the value here would be one. Required when passing order_interval_unit.
Warning: This update will remove skips and manually updated charges.
|
|
order_interval_unit |
The period in which the product is shipped as configured in the ruleset. For example, if a product were configured to ship every month, the value would be "month."
Warning: This update will remove skips and manually updated charges.
|
BULK CANCELLATIONS |
|
|
status |
The status of the charge. Depending on which export you pull, the status will be different. Values are ACTIVE or CANCELLED. This column is required for bulk cancellations. |
|
cancellation_reason |
The reason the product has been canceled from the customer's subscription. This can be selected by the store owner, customer, or automatically by Recharge (e.g., max retries reached). This column is optional for bulk cancellations. |
|
send_email |
Determines whether to send an update email to the customer. Values are True or False. This column is only available for bulk cancellations. |
PRODUCT TITLE OR VARIANT TITLE UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
product_title |
The title of the subscription product. This column is required for product title updates. |
|
variant_title |
The title of the specific variant that the subscriber is subscribed to. This column is optional if you do not use variants. |
RECURRING PRICE UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
recurring_price |
The recurring cost for the subscription product. This column is required for recurring price updates. |
NEXT CHARGE DATE UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
next_charge_scheduled_at |
When will the customer be billed for this subscription in YYYY-MM-DD format.
Note: Time will be reset to 00:00:00
This column is required for next charge date updates. |
CHARGE DAY OF THE MONTH OR WEEK UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
order_day_of_month |
The specific day of the month the product is submitted to your eCommerce platform on a recurring basis.
Note: Only valid if order_interval_unit is month.
|
|
order_day_of_week |
The specific day of the week the product is submitted to your eCommerce platform on a recurring basis.
Note: Only valid if order_interval_unit is week
|
EXPIRE AFTER [x] AMOUNT OF CHARGES UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
expire_after_specific_number_of_charges |
The number of charges before the subscription expires. |
PRODUCT SWAP UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
product_title |
The title of the subscription product. This column is optional for product swap updates. |
|
variant_title |
The title of the specific variant that the subscriber is subscribed to. This column is required for product swap updates. |
|
external_variant_id |
A unique string of numbers is used to identify the specific variant on the subscription. Even if a product has no variants created in your eCommerce platform, it will still have one variant ID assigned. Recharge uses the variant ID to create each charge. This column is required for BigCommerce stores. To locate variant IDs for this column, see Finding and exporting BigCommerce product and variant IDs. This column is optional for Shopify stores if you do not use variant IDs. |
LINE ITEM PROPERTIES UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
properties |
Line item properties are custom forms on a product used to collect additional customization information. Must be styled in JSON format. For example: |
SKU UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
sku |
This column reflects if any SKU overrides exist and will be populated if `sku_override` is set. |
|
sku_override |
If a SKU override exists, this column will show the actual SKU used to create the charge. Retrieved from `general_arttributes[sku_override]` Values are True or False. If set to True, we will override the SKU set on Shopify. |
OTHER UPDATES |
|
|
subscription_id |
The numerical Subscription ID associated with a customer’s subscription. If you need to find Subscription IDs in Recharge:
This column is required for all bulk update types. |
|
created_at |
The date the product was added. |
|
quantity |
This is the number of products ordered. |
Step 2 - Import the CSV file
Note: Ensure you delete the columns you do not need on your CSV file, or the import may fail and return errors.
After preparing the CSV file, you must import the file into the bulk management tool.
- From the merchant portal, click Subscriptions and select Import updates.
- Select your update type from the drop-down menu and click Next.
- Upload the prepared CSV file and click Next.
- Confirm the details of your update and select Validate your file. Depending on the file size, the validation process may take some time to complete. Once the process is completed, you will receive a confirmation email.
Step 3 - Perform the bulk update
Once your file is validated, you can perform the bulk update.
- In the merchant portal, click Data and select Bulk updates to view your validated files.
- Click Process update to begin the bulk update.
- On the pop-up modal, click Update subscriptions to confirm the bulk update.
- Once the update is done, the Processing status will be marked Complete, and the Results will display the number of subscriptions updated.
- From the merchant portal, click Subscriptions to confirm the updated charge dates are correct.
Revert, delete, or cancel the bulk update
If records cannot be processed or you encounter issues with the update, you can revert the bulk update using a backup file.
Revert using a backup file
- From the merchant portal, click Data and select Bulk updates.
- Click the three dots, and choose Download backup CSV. Use the following table for a summary of each file type:
FILE TYPE
SUMMARY
Error Records that pulled errors during the update are displayed in this download. Success Records after a completed bulk update. Backup Original records if you need to undo an update that was processed. - Use the backup CSV file to run another bulk update. This will override any changes from the original bulk update.
Delete the bulk update
To delete a bulk update:
- From the merchant portal, click Data and select Bulk updates.
- Click the three dots and select Delete update.
Cancel the bulk update
The cancel update prompt only displays during processing. You can cancel the bulk update process if you need to edit the CSV file before processing is complete.
- In the merchant portal, click Data and select Bulk updates.
- Click the three dots, and select Cancel update.
