Recharge

Recharge helps ecommerce businesses by offering subscriptions and recurring billing for their customers.

For more information about the API, see Recharge Payments API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling CDC for replication tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To generate the access token:

Make sure you have a Shopify account. You need it to access your Recharge information.
Log into your Shopify account, select Apps, and then click your Recharge application.
Go to the Tools & apps page.
Click API tokens.
Click Create an API token.
On the Create an API token page:
- In the Details section, enter a Token nickname and Contact email into their respective fields.
- In the Permission section, select the Read Access scope for each permission.
Click Save.
Copy the token.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Access Token	Access token.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 2.

Depending on your destination, table and column names may not appear as they are outlined below.

addresses

The addresses table contains info about the addresses (shipping locations) a customer has. A subscription is tied to a given address, but a customer can have multiple addresses.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join addresses with	on
charges	addresses.id = charges.address_id addresses.customer_id = charges.customer_id
onetimes	addresses.id = onetimes.address_id addresses.customer_id = onetimes.customer_id
orders	addresses.id = orders.address_id addresses.customer_id = orders.customer_id
subscriptions	addresses.id = subscriptions.address_id addresses.customer_id = subscriptions.customer_id
customers	addresses.customer_id = customers.id
discounts	addresses.discount_id = discounts.id

address1

STRING

address2

STRING

cart_attributes

ARRAY

This is a nested data structure:

name: STRING
value: STRING

cart_note

STRING

city

STRING

company

STRING

country

STRING

country_code

STRING

created_at

DATE-TIME

customer_id

INTEGER

discount_id

INTEGER

discounts

ARRAY

This is a nested data structure:

id: INTEGER

first_name

STRING

INTEGER

last_name

STRING

note_attributes

ARRAY

This is a nested data structure:

name: STRING
value: STRING

order_attributes

ARRAY

This is a nested data structure:

name: STRING
value: STRING

order_note

STRING

original_shipping_lines

ARRAY

This is a nested data structure:

code: STRING
price: STRING
title: STRING

payment_method_id

INTEGER

phone

STRING

presentment_currency

STRING

province

STRING

shipping_lines_override

ARRAY

This is a nested data structure:

code: STRING
price: STRING
title: STRING

updated_at

DATE-TIME

zip

STRING

charges

The charges table contains info about charges. A charge is a placeholder for an upcoming charge once the charge is processed successfully.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join charges with	on
addresses	charges.address_id = addresses.id charges.customer_id = addresses.customer_id
onetimes	charges.address_id = onetimes.address_id charges.customer_id = onetimes.customer_id charges.line_items.shopify_product_id = onetimes.shopify_product_id
orders	charges.address_id = orders.address_id charges.id = orders.charge_id charges.customer_id = orders.customer_id charges.line_items.shopify_product_id = orders.line_items.shopify_product_id charges.line_items.subscription_id = orders.line_items.subscription_id
subscriptions	charges.address_id = subscriptions.address_id charges.customer_id = subscriptions.customer_id charges.line_items.shopify_product_id = subscriptions.shopify_product_id charges.line_items.subscription_id = subscriptions.id
customers	charges.customer_id = customers.id
products	charges.line_items.shopify_product_id = products.id

address_id

INTEGER

analytics_data

OBJECT

This is a nested data structure: utm_params, ARRAY, which is also a nested data structure

utm_campaign: STRING
utm_content: STRING
utm_data_source: STRING
utm_medium: STRING
utm_source: STRING
utm_term: STRING
utm_timestamp: STRING

billing_address

OBJECT

This is a nested data structure:

address1: STRING
address2: STRING
city: STRING
company: STRING
country: STRING
country_code: STRING
first_name: STRING
last_name: STRING
phone: STRING
province: STRING
zip: STRING

browser_ip

STRING

client_details

OBJECT

This is a nested data structure:

browser_ip: STRING
user_agent: STRING

created_at

DATE-TIME

currency

STRING

customer

OBJECT

This is a nested data structure:

email: STRING
external_customer_id: OBJECT, which is also a nested data structure:
- ecommerce: STRING
hash: STRING
id: INTEGER

customer_hash

STRING

customer_id

INTEGER

discount_codes

ARRAY

This is a nested data structure:

amount: STRING
code: STRING
id: INTEGER
value: NUMBER
value_type: STRING

email

STRING

external_order_id

OBJECT

This is a nested data structure: ecommerce, STRING.

external_transaction_id

OBJECT

This is a nested data structure: payment_processor, STRING.

first_name

STRING

has_uncommited_changes

BOOLEAN

INTEGER

last_name

STRING

line_items

ARRAY

This is a nested data structure:

external_product_id, OBJECT, which is also a nested data structure:
- ecommerce: STRING
external_product_id, OBJECT, which is also a nested data structure:
- ecommerce: STRING
grams: INTEGER
handle: STRING
images: OBJECT
- large: STRING
- medium: STRING
- original: STRING
- small: STRING
- sort_order: INTEGER
price: STRING
properties: ARRAY, which is also a nested data structure:
- name: STRING
- value: STRING
purchase_item_id: INTEGER
purchase_item_type: STRING
quantity: STRING
shopify_product_id: STRING
shopify_variant_id: STRING
sku: STRING
subscription_id: INTEGER
tax_due: STRING
tax_lines: ARRAY, which is also a nested data structure:
- price: STRING
- rate: STRING
- title: STRING
taxable: BOOLEAN
taxable_amount: STRING
title: STRING
total_price: STRING
unit_price: STRING
unit_price_includes_tax: BOOLEAN
variant_title: BOOLEAN

note

STRING

note_attributes

ARRAY

This is a nested data structure:

name: STRING
value: STRING

order_attributes

ARRAY

This is a nested data structure:

name: STRING
value: STRING

orders_count

INTEGER

payment_processor

STRING

processed_at

DATE-TIME

processor_name

STRING

retry_date

DATE-TIME

scheduled_at

DATE-TIME

shipments_count

INTEGER

shipping_address

OBJECT

This is a nested data structure:

address1: STRING
address2: STRING
city: STRING
company: STRING
country: STRING
country_code: STRING
first_name: STRING
last_name: STRING
phone: STRING
province: STRING
zip: STRING

shipping_lines

ARRAY

This is a nested data structure:

code: STRING
price: STRING
source: STRING
tax_lines: ARRAY, which is also a nested data structure:
- price: STRING
- rate: STRING
- title: STRING
taxable: STRING
title: STRING

shopify_order_id

STRING

status

STRING

sub_total

STRING

subtotal_price

STRING

tags

STRING

tax_lines

ARRAY

This is a nested data structure:

price: STRING
rate: STRING
title: STRING

taxable

BOOLEAN

total_discounts

STRING

total_line_items_price

STRING

total_price

STRING

total_refunds

STRING

total_tax

STRING

total_weight

INTEGER

total_weight_grams

INTEGER

transaction_id

STRING

type

STRING

updated_at

DATE-TIME

collections

The collections table contains info about your collections.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join collections with	on
products	collections.id = products.collection_id

created_at

DATE-TIME

description

STRING

INTEGER

name

STRING

sort_order

STRING

title

STRING

type

STRING

updated_at

DATE-TIME

customers

The customers table contains info about customer accounts with a store.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join customers with	on
addresses	customers.id = addresses.customer_id
charges	customers.id = charges.customer_id
onetimes	customers.id = onetimes.customer_id
orders	customers.id = orders.customer_id
subscriptions	customers.id = subscriptions.customer_id

analytics_data

OBJECT

This is a nested data structure: utm_params, ARRAY, which is also a nested data structure:

utm_campaign: STRING
utm_content: STRING
utm_data_source: STRING
utm_medium: STRING
utm_source: STRING
utm_term: STRING
utm_timestamp: STRING

billing_address1

STRING

billing_address2

STRING

billing_city

STRING

billing_company

STRING

billing_country

STRING

billing_phone

STRING

billing_province

STRING

billing_zip

STRING

braintree_customer_token

STRING

created_at

DATE-TIME

email

STRING

external_customer_id

OBJECT

This is a nested data structure: ecommerce: STRING

first_charge_processed_at

DATE-TIME

first_name

STRING

has_card_error_in_dunning

BOOLEAN

has_payment_method_in_dunning

BOOLEAN

has_valid_payment_method

BOOLEAN

hash

STRING

INTEGER

last_name

STRING

number_active_subscriptions

INTEGER

number_subscriptions

INTEGER

paypal_customer_token

STRING

processor_type

STRING

reason_payment_method_not_valid

STRING

status

STRING

subscriptions_active_count

INTEGER

subscriptions_total_count

INTEGER

updated_at

DATE-TIME

discounts

The discounts table contains info about discounts.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join discounts with	on
addresses	discounts.id = addresses.discount_id

applies_to

OBJECT

This is a nested data structure:ids: ARRAY, which is also a nested data structure:

purchase_item_type: STRING
resource: STRING

applies_to_id

INTEGER

applies_to_product_type

STRING

applies_to_resource

STRING

channel_settings

OBJECT

This is a nested data structure:

api, OBJECT, which is also a nested data structure:
- can_apply: BOOLEAN
checkout_page: OBJECT, which is also a nested data structure:
- can_apply: BOOLEAN
customer_portal: OBJECT, which is also a nested data structure:
- can_apply: BOOLEAN
merchant_portal: OBJECT, which is also a nested data structure:
- can_apply: BOOLEAN

code

STRING

created_at

DATE-TIME

duration

STRING

duration_usage_limit

INTEGER

ends_at

DATE-TIME

external_discount_id

OBJECT

This is a nested data structure: ecommerce: STRING.

first_time_customer_restriction

BOOLEAN

INTEGER

once_per_customer

BOOLEAN

prerequisite_subtotal_min

STRING

starts_at

DATE-TIME

status

STRING

times_used

INTEGER

updated_at

DATE-TIME

usage_limit

INTEGER

usage_limits

OBJECT

This is a nested data structure:

first_time_customer_restriction: BOOLEAN
max_subsequent_redemptions: INTEGER
one_application_per_customer: STRING

value

STRING

value_type

STRING

metafields_customer

The metafields_customer table contains info about metafields related to customers.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

created_at

DATE-TIME

description

STRING

INTEGER

key

STRING

namespace

STRING

owner_id

STRING

owner_resource

STRING

updated_at

DATE-TIME

value

STRING

value_type

STRING

metafields_store

The metafields_store table contains info about metafields related to stores.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

created_at

DATE-TIME

description

STRING

INTEGER

key

STRING

namespace

STRING

owner_id

STRING

owner_resource

STRING

updated_at

DATE-TIME

value

STRING

value_type

STRING

metafields_subscription

The metafields_subscription table contains info about metafields related to subscriptions.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

created_at

DATE-TIME

description

STRING

INTEGER

key

STRING

namespace

STRING

owner_id

STRING

owner_resource

STRING

updated_at

DATE-TIME

value

STRING

value_type

STRING

onetimes

The onetimes table contains info about one time products.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join onetimes with	on
addresses	onetimes.address_id = addresses.id onetimes.customer_id = addresses.customer_id
charges	onetimes.address_id = charges.address_id onetimes.customer_id = charges.customer_id onetimes.shopify_product_id = charges.line_items.shopify_product_id
orders	onetimes.address_id = orders.address_id onetimes.customer_id = orders.customer_id onetimes.shopify_product_id = orders.line_items.shopify_product_id
subscriptions	onetimes.address_id = subscriptions.address_id onetimes.customer_id = subscriptions.customer_id onetimes.shopify_product_id = subscriptions.shopify_product_id
customers	onetimes.customer_id = customers.id
products	onetimes.shopify_product_id = products.id

address_id

INTEGER

created_at

DATE-TIME

customer_id

INTEGER

external_product_id

OBJECT

This is a nested data structure: ecommerce, STRING.

external_variant_id

OBJECT

This is a nested data structure: ecommerce, STRING.

INTEGER

next_charge_scheduled_at

DATE-TIME

price

STRING

product_title

STRING

properties

ARRAY

This is a nested data structure:

name: STRING
value: STRING

quantity

INTEGER

recharge_product_id

INTEGER

shopify_product_id

INTEGER

shopify_variant_id

INTEGER

sku

STRING

sku_override

BOOLEAN

status

STRING

updated_at

DATE-TIME

variant_title

STRING

orders

The orders table contains info about orders. Orders are created after a charge is successfully processed.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join orders with	on
addresses	orders.address_id = addresses.id orders.customer_id = addresses.customer_id
charges	orders.address_id = charges.address_id orders.charge_id = charges.id orders.customer_id = charges.customer_id orders.line_items.shopify_product_id = charges.line_items.shopify_product_id orders.line_items.subscription_id = charges.line_items.subscription_id
onetimes	orders.address_id = onetimes.address_id orders.customer_id = onetimes.customer_id orders.line_items.shopify_product_id = onetimes.shopify_product_id
subscriptions	orders.address_id = subscriptions.address_id orders.customer_id = subscriptions.customer_id orders.line_items.shopify_product_id = subscriptions.shopify_product_id orders.line_items.subscription_id = subscriptions.id
customers	orders.customer_id = customers.id
products	orders.line_items.shopify_product_id = products.id

address_id

INTEGER

address_is_active

INTEGER

billing_address

OBJECT

This is a nested data structure:

address1: STRING
address2: STRING
city: STRING
company: STRING
country: STRING
country_code: STRING
first_name: STRING
last_name: STRING
phone: STRING
province: STRING
zip: STRING

charge

OBJECT

This is a nested data structure:

external_transaction_id OBJECT, which is also a nested data structure:
- payment_processor: STRING
id: INTEGER

charge_id

INTEGER

charge_status

STRING

client_details

OBJECT

This is a nested data structure:

browser_ip: STRING
user_agent: STRING

created_at

DATE-TIME

currency

STRING

customer

OBJECT

This is a nested data structure:

email: STRING
external_customer_id: OBJECT, which is also a nested data structure:
- ecommerce: STRING
hash: STRING
id: INTEGER

customer_id

INTEGER

discount_codes

ARRAY

This is a nested data structure:

amount: STRING
code: STRING
type: STRING

discounts

ARRAY

This is a nested data structure:

code: STRING
id: INTEGER
value: NUMBER
value_type: STRING

email

STRING

external_cart_token

STRING

external_order_id

OBJECT

This is a nested data structure: ecommerce, STRING.

external_order_number

OBJECT

This is a nested data structure: ecommerce, STRING.

first_name

STRING

hash

STRING

INTEGER

is_prepaid

BOOLEAN

last_name

STRING

line_items

ARRAY

This is a nested data structure:

external_product_id: OBJECT, which is also a nested data structure:
- ecommerce: STRING
external_variant_id: OBJECT, which is also a nested data structure:
- ecommerce: STRING
grams: INTEGER
handle: STRING
images: OBJECT, which is also a nested data structure:
- large: STRING
- medium: STRING
- original: STRING
- small: STRING
- sort_order: INTEGER
price: NUMBER
properties: ARRAY, which is also a nested data structure:
- name: STRING
- value: STRING
purchase_item_id: INTEGER
purchase_item_type: STRING
quantity: INTEGER
shopify_product_id: STRING
shopify_variant_id: STRING
sku: STRING
sort_order: INTEGER
subscription_id: INTEGER
tax_due: STRING
tax_lines: ARRAY, which is also a nested data structure:
- price: STRING
- rate: STRING
- title: INTEGER
taxable: BOOLEAN
taxable_amount: STRING
title: STRING
total_price: STRING
unit_price: STRING
unit_price_includes_tax: BOOLEAN
variant_title: STRING

note

STRING

note_attributes

ARRAY

This is a nested data structure:

name: STRING
value: STRING

order_attributes

ARRAY

This is a nested data structure:

name: STRING
value: STRING

payment_processor

STRING

processed_at

DATE-TIME

scheduled_at

DATE-TIME

shipped_date

DATE-TIME

shipping_address

OBJECT

This is a nested data structure:

address1: STRING
address1: STRING
city: STRING
company: STRING
country: STRING
country_code: STRING
first_name: STRING
last_name: STRING
phone: STRING
province: STRING
zip: STRING

shipping_date

DATE-TIME

shipping_lines

ARRAY

This is a nested data structure:

code: STRING
price: STRING
source: STRING
tax_lines: ARRAY, which is also a nested data structre:
- price: STRING
- rate: STRING
- title: STRING
taxable: STRING
title: STRING

shopify_cart_token

STRING

shopify_customer_id

STRING

shopify_id

STRING

shopify_order_id

STRING

shopify_order_number

INTEGER

status

STRING

subtotal_price

STRING

tags

STRING

tax_lines

ARRAY

This is a nested data structure:

code: STRING
price: STRING
rate: STRING
title: STRING

taxable

BOOLEAN

total_discounts

STRING

total_line_items_price

NUMBER

total_price

STRING

total_refunds

STRING

total_tax

STRING

total_weight

INTEGER

total_weight_grams

INTEGER

transaction_id

STRING

type

STRING

updated_at

DATE-TIME

products

The products table contains info about your products. This table uses the 2021-01 API version.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge documentation Recharge API method

Join products with	on
collections	products.collection_id = collections.id
charges	products.id = charges.line_items.shopify_product_id
onetimes	products.id = onetimes.shopify_product_id
orders	products.id = orders.line_items.shopify_product_id
subscriptions	products.id = subscriptions.shopify_product_id

collection_id

INTEGER

created_at

DATE-TIME

discount_amount

NUMBER

discount_type

STRING

handle

STRING

INTEGER

images

OBJECT

This is a nested data structure:

large: STRING
medium: STRING
original: STRING
small: STRING

product_id

INTEGER

shopify_product_id

INTEGER

subscription_defaults

OBJECT

This is a nested data structure:

charge_interval_frequency: INTEGER
cutoff_day_of_month: STRING
cutoff_day_of_week: STRING
expire_after_specific_number_of_charges: INTEGER
handle: STRING
modifiable_properties: ARRAY, which is also a nested data structure:
- number_charges_until_expiration: INTEGER
- order_day_of_month: STRING
- order_day_of_week: STRING
- order_interval_frequency: INTEGER
- order_interval_frequency_options: ARRAY
  - order_interval_unit: STRING
  - storefront_purchase_options: STRING

title

STRING

updated_at

DATE-TIME

store

The store table contains info about your store.

Replication Method>

Full Table

Primary Key

Useful links

Recharge API method

checkout_logo_url

STRING

checkout_platform

STRING

created_at

DATE-TIME

currency

STRING

customer_portal_base_url

STRING

default_api_version

STRING

domain

STRING

email

STRING

external_platform

STRING

iana_timezone

STRING

INTEGER

identifier

STRING

merchant_portal_base_url

STRING

my_shopify_domain

STRING

name

STRING

phone

STRING

shop_email

STRING

shop_phone

STRING

timezone

OBJECT

This is a nested data structure:

iana_name: STRING
iana_timezone: STRING
name: STRING

updated_at

DATE-TIME

weight_unit

STRING

subscriptions

The subscriptions table contains info about subscriptions. Subscriptions are individual items that customers receive on a recurring basis.

Replication Method>	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Recharge API method

Join subscriptions with	on
addresses	subscriptions.address_id = addresses.id subscriptions.customer_id = addresses.customer_id
charges	subscriptions.address_id = charges.address_id subscriptions.customer_id = charges.customer_id subscriptions.shopify_product_id = charges.line_items.shopify_product_id subscriptions.id = charges.line_items.subscription_id
onetimes	subscriptions.address_id = onetimes.address_id subscriptions.customer_id = onetimes.customer_id subscriptions.shopify_product_id = onetimes.shopify_product_id
orders	subscriptions.address_id = orders.address_id subscriptions.customer_id = orders.customer_id subscriptions.shopify_product_id = orders.line_items.shopify_product_id subscriptions.id = orders.line_items.subscription_id
customers	subscriptions.customer_id = customers.id
products	subscriptions.shopify_product_id = products.id

address_id

INTEGER

analytics_data

OBJECT

This is a nested data structure: utm_params, ARRAY, which is also a nested data structure:

utm_campaign: STRING
utm_content: STRING
utm_data_source: STRING
utm_medium: STRING
utm_source: STRING
utm_term: STRING
utm_timestamp: STRING

cancellation_reason

STRING

cancellation_reason_comments

STRING

cancelled_at

DATE-TIME

charge_interval_frequency

STRING

created_at

DATE-TIME

customer_id

INTEGER

expire_after_specific_number_of_charges

INTEGER

external_product_id

OBJECT

This is a nested data structure: ecommerce, STRING.

external_variant_id

OBJECT

This is a nested data structure: ecommerce, STRING.

has_queued_charges

BOOLEAN

INTEGER

is_prepaid

BOOLEAN

is_skippable

BOOLEAN

is_swappable

BOOLEAN

max_retries_reached

BOOLEAN

next_charge_scheduled_at

DATE-TIME

order_day_of_month

STRING

order_day_of_week

STRING

order_interval_frequency

STRING

order_interval_unit

STRING

presentment_currency

STRING

price

STRING

product_title

STRING

properties

ARRAY

This is a nested data structure:

name: STRING
value: STRING

quantity

INTEGER

recharge_product_id

INTEGER

shopify_product_id

INTEGER

shopify_variant_id

INTEGER

sku

STRING

sku_override

BOOLEAN

status

STRING

updated_at

DATE-TIME

variant_title

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here