Skip to main content

How can we help?

Bulk managing discounts and addresses

Shopify Checkout integration Custom Recharge Checkout on BigCommerce BigCommerce Checkout Integration Migrated Shopify Checkout Integration
Sections

The merchant portal's bulk management feature provides a reliable in-app tool for updating subscriptions, charges, and addresses in bulk. Using this tool, you have the flexibility to perform bulk updates on your own timeline. This guide provides instructions on using the tool to update discounts and addresses in bulk. 

Before you start

Update subscriptions with the Import tool

Step 1 - Prepare a CSV file

Note: Bulk management tools have a max limit of 50,000 records. If you need to process more than 50,000 records, you must split the records into multiple CSV files and complete multiple bulk updates using the import tool.

You can use the Import tool to manage discounts and addresses in bulk. You must prepare the CSV file to update discounts and addresses in bulk. How you access the CSV template will differ depending on the update you are making:

CSV access instructions for updating addresses, or applying, removing, or deleting discounts

  1. In the merchant portal, click Tools & apps and select Exports.
  2. Download the export that corresponds to the task you are bulk performing: 
    • Apply discounts - Charges - Queued 
    • Remove discounts - Charges - Queued
    • Delete discounts - Discounts
    • Update addresses - Customers - Shipping addresses
  3. When the export has finished processing, download and open the export.
  4. Remove any charges from the export that you do not want to update discounts or addresses for.
Note: Removing a discount code removes the discount code from a customer's record. Deleting a discount code removes the code entirely from Recharge.

CSV access instructions for creating a discount code

  1. In the merchant portal, click Tools & apps and select Bulk Updates.
  2. Click Import updates.
  3. Select Create discounts from the update type options and click Next.
  4. Click upload template to download Recharge's CSV template for creating a discount code.

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 and delete unnecessary columns in the CSV file using the applicable properties for your bulk update type:

COLUMN TITLE

SUMMARY

APPLY DISCOUNTS
address_id

The numerical Address ID associated with a customer’s subscription. If you need to find Address IDs in Recharge:

  • Access the Charges, Orders, or Subscriptions exports.
  • View the Orders tab in your merchant portal.
  • Open a customer’s account and view their Subscription orders page.

This column is required for this update type because discounts apply directly to a customer's address.

discount_id OR

discount_code

When a discount code is applied to an address, a unique string of numbers is attributed to the code being used. The discount ID identifies a specific discount code used on a single charge.

OR 

The discount code created in the merchant portal.

REMOVE DISCOUNTS
address_id

The numerical Address ID associated with a customer’s subscription. If you need to find Address IDs in Recharge:

  • Access the Charges, Orders, or Subscriptions exports.
  • View the Orders tab in your merchant portal under the Customers tab.
  • Open a customer’s account and view their Subscription orders page.

This column is required for this update type because discounts apply directly to a customer's address.

CREATE DISCOUNTS
code

The name of the discount code you wish to create. Discount code names are not case-sensitive.

This column is required.
discount_type

The type of discount code you are offering. Choose from:

  • Fixed amount
  • Percentage
  • Shipping

This column is required.
value

The numerical value of the discount.

This column is required.
duration

The number of times the discount automatically applies to a new queued charge after it was first used on a successful charge. Choose from:

  • single_use
  • forever
  • usage_limit

This column is required.
duration_usage_limit

The specific number of times a discount code will automatically reapply. 

This column is required if the duration field is set to usage_limit.
starts_at

The date (YYYY-MM-DD) the discount code is available.

This date cannot be a date in the past. If this column is blank, the start date is the date the discount is created.
ends_at

The date (YYYY-MM-DD) the discount code is no longer available.

The discount code will not expire if this column is blank.
status

The active status of the discount code. 

The discount code is automatically enabled if this column is left blank.
usage_limit

The maximum number of purchases a discount can apply to. This is typically used when creating unique discount codes for individual customers.

No limit will apply if this column is left blank.
applies_to_resource

Specifies if this discount code should only apply to a specific product, or products in a specific collection. Choose between:

  • shopify_product
  • shopify_collection

The discount code will apply to all products and collections if this column is left blank.

applies_to_id

The ID of the product or the collection that the discount is limited to.

This column is required if the applies_to_resource field is populated.

applies_to_product_type

Choose the product types the discount should apply to. Use one of the following options:

  • ALL
  • ONETIME
  • SUBSCRIPTION

The discount code will apply to all products if this column is left blank.
once_per_customer

Limit the discount code to one use per customer. Choose between:

  • TRUE
  • FALSE

If set to TRUE, the discount code is only applied once to each unique customer. The discount code defaults to FALSE if the column is left blank.
prerequisite_subtotal_min

The numerical value that is required as a minimum purchase amount before the discount code is applied.
first_time_customer_restriction

Restrict the discount code so that it is only applied to new customers with the value customer_must_not_exist_in_recharge.

If this column is left blank, both new and existing customers can use the discount code.
channel_settings

Limit where this discount code can be added to an order. You must use a valid JSON object with the following rules:

  • Keys must be one or more of: API, customer_portal, merchant_portal, checkout_page

  • Values must be either true or false in the format: {""can_apply"": false}

The discount code is available through all channels if this column is left blank. 

Example:

{"api": {"can_apply": true}, "checkout_page": {"can_apply": true}, "customer_portal": {"can_apply": true}, "merchant_portal": {"can_apply": true}}

DELETE DISCOUNTS
discount_id

The Recharge ID of the discount code you wish to delete. You can find the discount_id listed on the Discounts export, in the Recharge Export Builder.

This column is required.

UPDATE ADDRESSES
address_id

The numerical Address ID associated with a customer’s subscription. If you need to find Address IDs in Recharge:

  • Access the Charges, Orders, or Subscriptions exports.
  • View the Orders tab in your merchant portal under the Customers tab.
  • Open a customer’s account and view their Subscription orders page.

This column is required for this update type because discounts apply directly to a customer's address.
address1 The customer’s street address. This address may be different than the billing address if the person receiving the subscription and the cardholder live at different addresses. 
address2 Any additional address information such as apartment number or specific mailbox. This field is not mandatory. 
city The city where the subscriber is located. 
company (optional)

The customer's company.
country_code The country code for where the subscriber is located. 
first_name The customer’s first name listed on the subscription.
last_name The customer’s last name.
order_attributes (optional) Extra information that is added to the order. Each array entry will contain “name” and “value” keys.
order_notes (optional) The text placed in the "note" field of orders for an address. To overwrite the order note, enter a space in the field.
payment_method_id The ID of the payment method associated with the subscription.
phone (optional) The phone number of the person receiving the subscription. This is helpful if there are any problems with shipping or delivery.
presentment_currency (required for Multi-currency stores only) Currency that the customer checked out with.
province The customer's state or province.
shipping_lines_override

If a manual shipping override is present, the Name, Code, and Price of the shipping rate will be listed here.

Provide an example of the JSON required if you are setting up a shipping override. The JSON example must be in proper JSON format.

For example:

[{"code": "FREE", "price": "0", "title": "Recharge Shipping"}]
zip The customer’s zip or postal code.

Save and export your updated file as a CSV file. The file must be in CSV format to use the bulk management tool. 

Step 2 - Import the CSV file

After preparing the CSV file, you must import the file into the bulk management tool. 

  1. From the merchant portal, click Tools & apps and select Bulk updates.
  2. Click the Import updates button.
  3. Select your update type from the dropdown menu and click Next.
  4. Upload the prepared CSV file and click Next.
  5. Confirm the details of your update and select Validate your file. The validation process may take some time to complete, depending on the size of the file. Once the process is completed, you will receive a confirmation email.

    Preview mapping window

Step 3 - Perform the bulk update

Once your file is validated, you can perform the bulk update. 

  1. In the merchant portal, click Tools & apps and select Bulk updates to view your validated files.
  2. Click Process update to begin the bulk update.
    Process update button
  3. On the pop-up modal, click Update subscription(s) to confirm the bulk update. 
  4. Once the update is done, the Processing status will be marked Complete and the Results will display the number of charges updated. 
  5. From the merchant portal, select Customers and open a customer's profile.
  6. Confirm the correct discount code has been applied or removed, or confirm the customer's address has been updated. 

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. See Revert, delete, or cancel a bulk update.

Was this article helpful?
0 out of 0 found this helpful

Related articles

Didn’t find what you’re looking for?

Contact us