Recharge integration summary

Stitch’s Recharge integration replicates data using the Recharge Payments API. To access the Recharge API documentation, you will need your API key. Refer to the Schema section for a list of objects available for replication.

Recharge feature snapshot

A high-level look at Stitch's Recharge (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on January 27, 2020

 Supported by

Stitch
Stitch plan

Standard

 API availability

Not available
Singer GitHub repository

singer-io/tap-recharge
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Supported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Supported

 Column selection

Supported
Select all

Supported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Recharge

Recharge setup requirements

To set up Recharge in Stitch, you need:

  • A Shopify Account. You need this to access your Recharge information.

Step 1: Obtain your Recharge access token

  1. Log into your Shopify account, select Apps, and then click on your Recharge application.
Shopify Apps page.
  1. In the application, click the EXPLORE Recharge located near the top right corner of the page.
  2. Click on the Integrations tab, and then click API tokens….
Integrations page with API token link.
  1. Click on Create an API token.
  2. On the Create an API token page:
    • In the Details section, enter a Nickname and Contact email into their respective fields.
    • In the Permission section, select the Read Access scope for each permission.
  3. Click Save to create the Access Token.
The API key creation page.

Step 2: Add Recharge as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Recharge icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Recharge” would create a schema called stitch_recharge in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Access Token field, enter the access token you obtained in the previous step.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Recharge integration. This means that:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

Change this setting if you want to replicate data beyond Recharge’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Recharge integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Recharge integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.

  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.

  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Recharge, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Recharge table reference

addresses

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

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

addresses table schema

id
INTEGER

The address ID.

Reference:

updated_at
DATE-TIME

The date and time the address was last updated.

address1
STRING

The street associated with the address.

address2
STRING

Any additional information associated with the address.

cart_attributes
ARRAY

This field has been deprecated by Recharge. Use note_attributes instead.

Click to expand cart_attributes

name
STRING

value
STRING

addresses (table), cart_attributes (attribute)

cart_note
STRING

The note that that will be passed to the note field of orders made within the address.

city
STRING

The city associated with the address.

company
STRING

The company associated with the address.

country
STRING

The country associated with the address.

created_at
DATE-TIME

The date and time when the address was created.

customer_id
INTEGER

The ID of the customer associated with the address.

Reference:

discount_id
INTEGER

The ID of the discount that is applied on the address.

Reference:

first_name
STRING

The customer’s first name associated with the address.

last_name
STRING

The customer’s last name associated with the address.

note_attributes
ARRAY

Extra information that is added to the order.

Click to expand note_attributes

name
STRING

value
STRING

addresses (table), note_attributes (attribute)

original_shipping_lines
ARRAY

This field has been deprecated by Recharge. Use shipping_lines_override instead.

Click to expand original_shipping_lines

code
STRING

A reference to the shipping used.

price
STRING

The price of the shipping used.

title
STRING

The title of the shipping used.
addresses (table), original_shipping_lines (attribute)

phone
STRING

The phone number associated with the address.

province
STRING

The state or province associated with the address.

shipping_lines_override
ARRAY

Details about the shipping used if the original shipping for the address has been overridden.

Click to expand shipping_lines_override

code
STRING

A reference to the shipping used.

price
STRING

The price of the shipping used.

title
STRING

The title of the shipping used.
addresses (table), shipping_lines_override (attribute)

zip
STRING

The zip code associated with the address.

charges

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List charges

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

charges table schema

id
INTEGER

The charge ID.

Reference:

updated_at
DATE-TIME

The date and time the charge was last updated.

address_id
INTEGER

Reference:

billing_address
OBJECT

The billing information related to the charge.

Click to expand billing_address

address1
STRING

The street address of the billing address.

address2
STRING

An optional additional field for the street address of the billing address.

city
STRING

The city of the billing address.

company
STRING

The company of the person associated with the billing address.

country
STRING

The name of the country of the billing address.

first_name
STRING

The first name of the person associated with the payment method.

last_name
STRING

The last name of the person associated with the payment method.

phone
STRING

The phone number associated with the billing address.

province
STRING

The name of the state or province of the billing address.

zip
STRING

The zip or postal code of the billing address.
charges (table), billing_address (attribute)

browser_ip
STRING

client_details
OBJECT

Click to expand client_details

browser_ip
STRING

user_agent
STRING

charges (table), client_details (attribute)

created_at
DATE-TIME

The date and time the charge was created.

customer_hash
STRING

customer_id
INTEGER

The ID of the customer associated with the charge.

Reference:

discount_codes
ARRAY

Details about discounts applied to the charge.

Click to expand discount_codes

code
STRING

The title of the discount.

amount
STRING

The amount of the discount.

type
STRING

The type of the discount. For example: percentage
charges (table), discount_codes (attribute)

email
STRING

The email address associated with the charge.

first_name
STRING

The first name of the customer associated with the charge.

has_uncommited_changes
BOOLEAN

last_name
STRING

The last name of the customer associated with the charge.

line_items
ARRAY

Details about the items in the charge.

Click to expand line_items

grams
INTEGER

The weight of the item, in grams.

images
OBJECT

Images associated with the item.

price
STRING

The price of the item.

properties
ARRAY

Custom information for an item that has been added to the cart.

Click to expand properties

name
STRING

value
STRING

charges (table), properties (attribute)

quantity
INTEGER

The number of products that were purchased.

shopify_product_id
STRING

The ID of the Shopify product.

Reference:

shopify_variant_id
STRING

The ID of the Shopify product variant.

Reference:

sku
STRING

A unique identifier of the item in the fulfillment.

subscription_id
INTEGER

The ID of the subscription associated with the charge.

Reference:

title
STRING

The title of the product.

variant_title
STRING

The title of the product variant.
charges (table), line_items (attribute)

note
STRING

Shows the next order in sequence.

note_attributes
ARRAY

Click to expand note_attributes

name
STRING

value
STRING

charges (table), note_attributes (attribute)

processed_at
DATE-TIME

The date and time when the transaction was created.

processor_name
STRING

The name of the processor of the charge.

scheduled_at
DATE-TIME

The date the charge is scheduled for.

shipments_count
INTEGER

The number of successfully sent orders for the specific charge.

shipping_address
OBJECT

The shipping information related to the charge.

Click to expand shipping_address

address1
STRING

The street address of the shipping address.

address2
STRING

An optional additional field for the street address of the shipping address.

city
STRING

The city of the shipping address.

company
STRING

The company of the person associated with the shipping address.

country
STRING

The name of the country of the shipping address.

first_name
STRING

The first name of the person associated with the payment method.

last_name
STRING

The last name of the person associated with the payment method.

phone
STRING

The phone number associated with the shipping address.

province
STRING

The name of the state or province of the shipping address.

zip
STRING

The zip or postal code of the shipping address.
charges (table), shipping_address (attribute)

shipping_lines
ARRAY

Details about the shipping used for the charge.

Click to expand shipping_lines

code
STRING

A reference to the shipping used.

price
STRING

The price of the shipping used.

title
STRING

The title of the shipping used.
charges (table), shipping_lines (attribute)

shopify_order_id
STRING

The ID of the charge within Shopify.

Reference:

status
STRING

The status of creating the charge within Shopify. Possible values are:

  • SUCCESS
  • ERROR
  • QUEUED
  • SKIPPED
  • REFUNDED
  • PARTIALLY_REFUNDED

sub_total
STRING

subtotal_price
STRING

The item price without taxes and discounts.

tags
STRING

tax_lines
ARRAY

Details about the tax lines associated with the order.

Click to expand tax_lines

code
STRING

The code of the tax to be applied.

price
STRING

The price of the tax to be applied.

title
STRING

The title of the tax to be applied.
charges (table), tax_lines (attribute)

total_discounts
STRING

The sum of the discounts applied to the product.

total_line_items_price
STRING

total_price
STRING

The sum of all the prices of all the items in the charge, including taxes and discounts.

total_refunds
NUMBER

The sum of all refunds that were made on specific charge.

total_tax
NUMBER

The sum of the taxes applied to the product.

total_weight
INTEGER

transaction_id
STRING

The ID of the transaction associated with the charge.

Reference:

type
STRING

The type of the charge.

collections

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List collections

The collections table contains info about your collections.

collections table schema

id
INTEGER

The collection ID.

Reference:

updated_at
DATE-TIME

The date and time when the collection was last updated.

created_at
DATE-TIME

The date and time when the collection was created.

name
STRING

The name of the collection.

customers

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List customers

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

customers table schema

id
INTEGER

The customer ID.

Reference:

updated_at
DATE-TIME

The date and time when the customer was last updated.

billing_address1
STRING

The customer’s billing address.

billing_address2
STRING

Additional data about the customer’s billing address.

billing_city
STRING

The customer’s billing city.

billing_company
STRING

The customer’s billing company.

billing_country
STRING

The customer’s billing country.

billing_phone
STRING

The customer’s billing phone.

billing_province
STRING

The customer’s billing state or province.

billing_zip
STRING

The customer’s billing zip code.

braintree_customer_token
STRING

The customer’s token in Braintree.

created_at
DATE-TIME

The date and time the customer was created.

email
STRING

The customer’s email address.

first_charge_processed_at
DATE-TIME

The date when first charge was processed for customer.

first_name
STRING

The customer’s first name.

has_card_error_in_dunning
BOOLEAN

If true, the customer has a card with an error in the dunning process.

has_valid_payment_method
BOOLEAN

If true, the customer has a valid payment method.

hash
STRING

The string identifier used in the customer’s portal link.

last_name
STRING

The customer’s last name.

number_active_subscriptions
INTEGER

The number of active subscriptions associated with the customer.

number_subscriptions
INTEGER

The number of subscriptions for the customer.

paypal_customer_token
STRING

The customer’s token for PayPal.

processor_type
STRING

The type of processor associated with the customer.

reason_payment_method_not_valid
STRING

The reason the customer’s payment method is invalid.

shopify_customer_id
STRING

The customer’s ID in Shopify.

Reference:

status
STRING

The status of the customer. Possible values are active and failed.

discounts

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List discounts

The discounts table contains info about discounts.

discounts table schema

id
INTEGER

The discount ID.

Reference:

updated_at
DATE-TIME

The date and time the discount was created.

applies_to_id
INTEGER

The ID of the product or collection associated with the discount.

applies_to_product_type
STRING

The type of product the discount applies to. Possible values are:

  • ALL
  • ONETIME
  • SUBSCRIPTION

applies_to_resource
STRING

The type of resource the discount applies to. Possible values are:

  • shopify_product
  • shopify_collection_id

code
STRING

The name of the discount.

created_at
DATE-TIME

The date and time the discount was created.

duration
STRING

The number of times a discount will be automatically re-applied to a new queued charge after its first use on a successful charge. Possible values are:

  • forever: The discount will re-apply unlimited times
  • usage_limit: The discount will re-apply based on the duration_usage_limit value
  • simple_use: The discount will not re-apply

duration_usage_limit
INTEGER

Applicable only when duration: usage_limit. The number of times a discount will be automatically re-applied to a new queued charge after its first use on a successful charge.

ends_at
DATE-TIME

The date when the discount expires.

once_per_customer
BOOLEAN

If true, the discount can only be used for a given customer checkout or manually applied once on the customer portal. Once applied, it will continue to be reapplied to each new charge on the address unless the discount_duration specifies otherwise.

starts_at
DATE-TIME

The date when the discount begins.

status
STRING

The status of the discount. Possible values are:

  • enabled
  • disabled
  • fully_disabled

times_used
INTEGER

The number of times the discount was used by customers at checkout.

usage_limit
INTEGER

The maximum number of times the discount can be used by all customers.

value
INTEGER

The discounted value to be applied.

metafields_customer

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List customer metafields

The metafields_customer table contains info about metafields related to customers.

metafields_customer table schema

id
INTEGER

The customer metafield ID.

updated_at
DATE-TIME

The date and time the customer metafield was last updated.

created_at
DATE-TIME

The date and time the customer metafield was created.

description
STRING

The description of the metafield.

key
STRING

The name of the metafield.

namespace
STRING

The category or container that differentiates the metafield from other fields.

owner_id
INTEGER

The ID of the owner resource.

Reference:

owner_resource
STRING

The type of resource that owns the metafield. This will be customer.

value
STRING

The content of the metafield.

value_type
STRING

The data type of the metafield. For example: integer

metafields_store

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List store metafields

The metafields_store table contains info about metafields related to stores.

metafields_store table schema

id
INTEGER

The store metafield ID.

updated_at
DATE-TIME

The date and time the store metafield was last updated.

created_at
DATE-TIME

The date and time the store metafield was created.

description
STRING

The description of the metafield.

key
STRING

The name of the metafield.

namespace
STRING

The category or container that differentiates the metafield from other fields.

owner_id
INTEGER

The ID of the owner resource.

Reference:

owner_resource
STRING

The type of resource that owns the metafield. This will be store.

value
STRING

The content of the metafield.

value_type
STRING

The data type of the metafield. For example: integer

metafields_subscription

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List subscription metafields

The metafields_subscription table contains info about metafields related to subscriptions.

metafields_subscription table schema

id
INTEGER

updated_at
DATE-TIME

The date and time the subscription metafield was last updated.

created_at
DATE-TIME

The date and time the subscription metafield was created.

description
STRING

The description of the metafield.

key
STRING

The name of the metafield.

namespace
STRING

The category or container that differentiates the metafield from other fields.

owner_id
INTEGER

The ID of the owner resource.

owner_resource
STRING

The type of resource that owns the metafield. This will be subscription.

value
STRING

The content of the metafield.

value_type
STRING

The data type of the metafield. For example: integer

onetimes

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List onetimes

The onetimes table contains info about one time products.

onetimes table schema

id
INTEGER

The ID of the one time product.

updated_at
DATE-TIME

The date and time the one time product was last updated.

address_id
INTEGER

The ID of the address the one time product is associated with.

Reference:

created_at
DATE-TIME

The date and time the one time product was created.

customer_id
INTEGER

The ID of the customer the one time product is associated with.

Reference:

next_charge_scheduled_at
DATE-TIME

The date of the one time product execution.

price
NUMBER

The price of the item before discounts, taxes, or shipping have been applied.

product_title
STRING

The name of the one time product in a shop’s catalog.

properties
ARRAY

Click to expand properties

name
STRING

value
STRING

onetimes (table), properties (attribute)

quantity
INTEGER

The number of items in the subscription.

recharge_product_id
INTEGER

The ID of the product in Recharge.

shopify_product_id
INTEGER

The ID of the product in Shopify.

Reference:

shopify_variant_id
INTEGER

The ID of the product variant in Shopify.

Reference:

sku
STRING

A unique identifier of the item in the fulfillment.

status
STRING

The status of the one time product.

variant_title
STRING

The name of the variant in a shop’s catalog.

orders

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List orders

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

orders table schema

id
INTEGER

The order ID.

updated_at
DATE-TIME

The date and time the order was last updated.

address_id
INTEGER

The ID of the customer address the order will ship to.

Reference:

address_is_active
INTEGER

If true, the address is inactive.

billing_address
OBJECT

The billing information related to the order.

Click to expand billing_address

address1
STRING

The street address of the billing address.

address2
STRING

An optional additional field for the street address of the billing address.

city
STRING

The city of the billing address.

company
STRING

The company of the person associated with the billing address.

country
STRING

The name of the country of the billing address.

first_name
STRING

The first name of the person associated with the payment method.

last_name
STRING

The last name of the person associated with the payment method.

phone
STRING

The phone number associated with the billing address.

province
STRING

The name of the state or province of the billing address.

zip
STRING

The zip or postal code of the billing address.
orders (table), billing_address (attribute)

charge_id
INTEGER

The ID of the charge associated with the order.

Reference:

charge_status
STRING

created_at
DATE-TIME

The date and time the order was created.

customer_id
INTEGER

The ID of the customer associated with the order.

Reference:

discount_codes
ARRAY

Details about the discounts applied to the order.

Click to expand discount_codes

code
STRING

The title of the discount.

amount
STRING

The amount of the discount.

type
STRING

The type of the discount. For example: percentage
orders (table), discount_codes (attribute)

email
STRING

The email address of the customer associated with the order.

first_name
STRING

The first name of the customer associated with the order.

hash
STRING

is_prepaid
INTEGER

If true (1), the order has been paid for a pre-determined number of months.

last_name
STRING

The last name of the customer associated with the order.

line_items
ARRAY

Details about the items in the order.

Click to expand line_items

grams
INTEGER

The weight of the item, in grams.

images
OBJECT

Images associated with the item.

price
STRING

The price of the item.

properties
ARRAY

Custom information for an item that has been added to the cart.

Click to expand properties

name
STRING

value
STRING

orders (table), properties (attribute)

quantity
INTEGER

The number of products that were purchased.

shopify_product_id
STRING

The ID of the Shopify product.

Reference:

shopify_variant_id
STRING

The ID of the Shopify product variant.

Reference:

sku
STRING

A unique identifier of the item in the fulfillment.

subscription_id
INTEGER

The ID of the subscription associated with the charge.

Reference:

title
STRING

The title of the product.

variant_title
STRING

The title of the product variant.
orders (table), line_items (attribute)

note
STRING

note_attributes
ARRAY

Click to expand note_attributes

name
STRING

value
STRING

orders (table), note_attributes (attribute)

payment_processor
STRING

The type of payment the processor has chosen.

processed_at
DATE-TIME

The date when the order was submitted.

scheduled_at
DATE-TIME

The date when the order will ship.

shipped_date
DATE-TIME

The date when the order shipped.

shipping_address
OBJECT

The shipping information related to the order.

Click to expand shipping_address

address1
STRING

The street address of the shipping address.

address2
STRING

An optional additional field for the street address of the shipping address.

city
STRING

The city of the shipping address.

company
STRING

The company of the person associated with the shipping address.

country
STRING

The name of the country of the shipping address.

first_name
STRING

The first name of the person associated with the payment method.

last_name
STRING

The last name of the person associated with the payment method.

phone
STRING

The phone number associated with the shipping address.

province
STRING

The name of the state or province of the shipping address.

zip
STRING

The zip or postal code of the shipping address.
orders (table), shipping_address (attribute)

shipping_date
DATE-TIME

The date when the order will be processed and sent to Shopify.

shipping_lines
ARRAY

Details about the shipping used for the order.

Click to expand shipping_lines

code
STRING

A reference to the shipping used.

price
STRING

The price of the shipping used.

title
STRING

The title of the shipping used.
orders (table), shipping_lines (attribute)

shopify_cart_token
STRING

The token generated by Shopify when an item is added to the order cart.

shopify_customer_id
STRING

The ID of the customer in Shopify.

Reference:

shopify_id
STRING

This field has been deprecated by Recharge. The ID of the order in Shopify.

shopify_order_id
STRING

The ID of the order in Shopify.

Reference:

shopify_order_number
INTEGER

The order number in Shopify.

status
STRING

The status of creating the order in Shopify.

subtotal_price
STRING

The sum of all of the prices of the items in the order, including taxes and discounts.

tags
STRING

tax_lines
ARRAY

Details about the tax lines associated with the order.

Click to expand tax_lines

code
STRING

The code of the tax to be applied.

price
STRING

The price of the tax to be applied.

title
STRING

The title of the tax to be applied.
orders (table), tax_lines (attribute)

total_discounts
NUMBER

The sum of total discounts applied to the order.

total_line_items_price
NUMBER

total_price
STRING

total_refunds
NUMBER

The sum of all refunds applied against the order.

total_tax
NUMBER

The sum of total tax applied to the order.

total_weight
INTEGER

The sum of all products in the order.

transaction_id
STRING

The ID of the transaction associated with the order.

Reference:

type
STRING

Indicates if the order was made from checkout or a recurring charge. Possible values are:

  • CHECKOUT
  • RECURRING

products

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List products

The products table contains info about your products.

products table schema

id
INTEGER

The product ID.

Reference:

updated_at
DATE-TIME

The date and time the product was last updated.

collection_id
INTEGER

The ID of the ruleset created in Recharge.

Reference:

created_at
DATE-TIME

The date and time the product was created.

discount_amount
NUMBER

The discount amount applied based on the Recharge ruleset.

discount_type
STRING

The type of discount applied to the product. For example: percentage

images
OBJECT

Images of the product in Shopify.

Click to expand images

large
STRING

The URL of the large image associated with the item.

medium
STRING

The URL of the medium image associated with the item.

original
STRING

The URL of the original image associated with the item.

small
STRING

The URL of the small image associated with the item.
products (table), images (attribute)

product_id
INTEGER

This field has been deprecated by Recharge. Use shopify_product_id instead. The ID of the product in Shopify.

shopify_product_id
INTEGER

The ID of the product in Shopify.

subscription_defaults
OBJECT

Defaults applied to subscription products.

Click to expand subscription_defaults

charge_interval_frequency
INTEGER

The number of units (specified in order_interval_unit) between each charge.

cutoff_day_of_month
STRING

The number of the day in a month on which customers will be charged. Cut-off windows create an interval between the day a customer goes through Recharge checkout to purchase a new subscription and when you charge that customer again for their recurring order. Possible values are 1 through 31.

cutoff_day_of_week
STRING

The number of the day in a week on which customers will be charged. Cut-off windows create an interval between the day a customer goes through Recharge checkout to purchase a new subscription and when you charge that customer again for their recurring order.

Possible values are:

  • 0: Monday
  • 1: Tuesday
  • 2: Wednesday
  • 3: Thursday
  • 4: Friday
  • 5: Saturday
  • 6: Sunday

expire_after_specific_number_of_charges
INTEGER

The number of charges until the subscription expires.

handle
STRING

number_charges_until_expiration
INTEGER

This field has been deprecated by Recharge. Use expire_after_specific_number_of_charges instead.

order_day_of_month
STRING

Applicable only to subscriptions where order_interval_unit: month. The set day of the month the order is created.

order_day_of_week
STRING

Applicable only to subscriptions where order_interval_unit: week. The set day of the week the order is created. A value of 0 equals Monday, 1 equals Tuesday, etc.

order_interval_frequency
INTEGER

The number of units (specified in order_interval_unit) between each order. For example: If order_interval_unit: month and order_interval_frequency: 3, there’d be an order every three months.

order_interval_frequency_options
ARRAY

The order interval frequency options customers can choose from.

Click to expand order_interval_frequency_options

value
STRING

The order interval frequency option.
products (table), order_interval_frequency_options (attribute)

order_interval_unit
STRING

The frequency with which a subscription should have an order created. Possible values are:

  • days
  • weeks
  • months

storefront_purchase_options
STRING

The purchase options for the subscription. Possible values are:

  • subscription_only: Products are only offered as a recurring subscription item
  • subscription_and_onetime: Products will have the option of being purchased as a one-time or as a recurring subscription item.
products (table), subscription_defaults (attribute)

title
STRING

The title of the product in Shopify.

shop

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Retrieve shop

The shop table contains info about your shop.

shop table schema

id
INTEGER

The shop ID.

checkout_logo_url
STRING

created_at
STRING

The date and time the shop was created.

currency
STRING

The currency used by the store. For example: USD

domain
STRING

The global domain name of the store.

email
STRING

This field has been deprecated by Recharge. Use shop_email instead.

iana_timezone
STRING

The timezone of the shop in Iana database timezone format.

my_shopify_domain
STRING

The store domain name in Shopify.

name
STRING

The name of the store.

shop_email
STRING

The email address of the shop owner.

shop_phone
STRING

The phone number of the shop owner.

timezone
STRING

The timezone of the shop.

updated_at
STRING

The date and time the shop was last updated.

subscriptions

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List subscriptions

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

subscriptions table schema

id
INTEGER

The ID of the subscription.

Reference:

updated_at
DATE-TIME

The date and time the subscription was created.

address_id
INTEGER

The ID of the address the subscription is associated with.

Reference:

cancellation_reason
STRING

The reason for the subscription cancellation.

cancellation_reason_comments
STRING

Additional information about cancellation.

cancelled_at
DATE-TIME

The time the subscription was canceled.

charge_interval_frequency
STRING

The number of units (specified in order_interval_unit) between each charge.

created_at
DATE-TIME

The date and time the subscription was created.

customer_id
INTEGER

The ID of the customer associated with the subscription.

Reference:

expire_after_specific_number_of_charges
INTEGER

The number of charges until the subscription expires.

has_queued_charges
INTEGER

Indicates if the subscription has a queued charge. If 1, there’s a queued charge.

is_skippable
BOOLEAN

If true, the item is not a prepaid item.

is_swappable
BOOLEAN

If true, the item isn’t a prepaid item and swapping is allowed for customers in the Customer portal settings.

max_retries_reached
INTEGER

Indicates if the charge on the subscription has reached the maximum number of error retries. If 1, the maximum has been reached.

next_charge_scheduled_at
DATE-TIME

The date of the next charge for subscription.

order_day_of_month
STRING

Applicable only to subscriptions where order_interval_unit: month. The set day of the month the order is created.

order_day_of_week
STRING

Applicable only to subscriptions where order_interval_unit: week. The set day of the week the order is created. A value of 0 equals Monday, 1 equals Tuesday, etc.

order_interval_frequency
STRING

The number of units (specified in order_interval_unit) between each order. For example: If order_interval_unit: month and order_interval_frequency: 3, there’d be an order every three months.

order_interval_unit
STRING

The frequency with which a subscription should have order created. Possible values are:

  • day
  • week
  • month

price
NUMBER

The price of the item before discounts, taxes, or shipping have been applied.

product_title
STRING

The name of the product in a shop’s catalog.

properties
ARRAY

A list of line item objects, each one containing information about the subscription.

Click to expand properties

name
STRING

value
STRING

subscriptions (table), properties (attribute)

quantity
INTEGER

The number of items on the subscription.

recharge_product_id
INTEGER

The ID of the product in Recharge.

shopify_product_id
INTEGER

The ID of the product in Shopify.

Reference:

shopify_variant_id
INTEGER

The ID of the product variant in Shopify.

Reference:

sku
STRING

A unique identifier of the item in the fulfillment.

sku_override
STRING

If true, the SKU on the subscription will be used to generate charges and orders. If false, Recharge will dynamically fetch the SKU from the corresponding Shopify variant.

status
STRING

The status of the subscription. Possible values are:

  • active
  • cancelled
  • expired

variant_title
STRING

The name of the variant in a shop’s catalog.
Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.