Schema Information of ReCharge Payments v3

Structured details and metadata about the Recharge Payments v2 connector and its corresponding tables and fields.

Need help with something?

Talk to data expert

Schema Information of ReCharge Payments v3

Structured details and metadata about the Recharge Payments v2 connector and its corresponding tables and fields.

The Recharge Payments connector replicates 10 subscription-commerce tables from the Recharge API (2021-11) into the warehouse, so teams can report on subscribers, recurring revenue, churn and discounts.

  • Authentication: OAuth 2.0 against the Recharge partner app; requests send the access token in the X-Recharge-Access-Token header with X-Recharge-Version: 2021-11.
  • Setup input: the Shopify shop domain (store name prefix of the store URL).
  • Replication: incremental by updated_at in 1-day windows (Events: created_at in 30-minute windows), cursor-based pagination, 100–250 records per page.
  • Schema layout: nested objects are flattened. Each table below lists only child columns, named parent_child (for example billing_address_city); the parent record columns are not listed.

Tables supported

All 10 tables use id as the primary key. The endpoint column shows the API path; the table name links to its API reference.

Table Purpose Endpoint Load type / replication key
Orders Recurring and checkout orders created by Recharge GET /orders Incremental, updated_at
Subscriptions Active and past subscription contracts GET /subscriptions Incremental, updated_at
Charges Scheduled and processed payment attempts GET /charges Incremental, updated_at
Customers Subscriber profiles and payment health GET /customers Incremental, updated_at
Discounts Discount codes and their usage rules GET /discounts Incremental, updated_at
Onetimes One-time products added to an upcoming charge GET /onetimes Incremental, updated_at
Addresses Shipping addresses attached to customers GET /addresses Incremental, updated_at
Collections Product collections used for subscription rules GET /collections Full load
Retention_Strategies Offers shown in the cancellation flow GET /retention_strategies Full load
Events Audit log of changes to Recharge objects GET /events Incremental, created_at (6 days of history); full load supported

Base URL for every endpoint: https://api.rechargeapps.com.

Orders

Purpose: one row per order Recharge creates, whether a recurring renewal or a checkout order. Use it for recurring revenue, order volume, discounts, taxes and shipping, and to join back to Shopify through the external_order_* columns.

API: GET /orders · Incremental on updated_at

Column Type Description
id NUMERIC Recharge order ID (primary key).
address_id NUMERIC Address the order ships to.
billing_address_address1 STRING Billing street address.
billing_address_city STRING Billing city.
billing_address_country_code STRING Billing country (ISO 3166).
billing_address_first_name STRING Billing first name.
billing_address_last_name STRING Billing last name.
billing_address_province STRING Billing state / province.
billing_address_zip STRING Billing postal code.
charge_id NUMERIC Charge that produced the order.
charge_external_transaction_id_payment_processor STRING Payment processor transaction reference.
charge_payment_processor_name STRING Payment processor name.
charge_status STRING Status of the originating charge.
client_details_browser_ip STRING Browser IP at checkout.
client_details_user_agent STRING Browser user agent at checkout.
created_at TIMESTAMP When the order was created.
currency STRING Currency code (ISO 4217).
customer_id NUMERIC Recharge customer ID.
customer_email STRING Customer email.
customer_external_customer_id_ecommerce STRING Shopify customer ID.
customer_hash STRING Recharge customer hash.
external_order_id_ecommerce STRING Shopify order ID.
external_order_name_ecommerce STRING Shopify order name (for example #1001).
external_order_number_ecommerce STRING Shopify order number.
is_prepaid BOOLEAN Whether the order belongs to a prepaid plan.
line_items_purchase_item_id NUMERIC Subscription or one-time item ID.
line_items_external_inventory_policy STRING Shopify inventory policy of the variant.
line_items_external_product_id_ecommerce STRING Shopify product ID.
line_items_external_variant_id_ecommerce STRING Shopify variant ID.
line_items_images_large STRING Large product image URL.
line_items_images_medium STRING Medium product image URL.
line_items_images_original STRING Original product image URL.
line_items_images_small STRING Small product image URL.
line_items_original_price STRING Price before discounts.
line_items_properties_name STRING Line item property name.
line_items_properties_value STRING Line item property value.
line_items_purchase_item_type STRING subscription or onetime.
line_items_quantity NUMERIC Units ordered.
line_items_sku STRING SKU.
line_items_tax_due STRING Tax due on the line.
line_items_taxable BOOLEAN Whether the line is taxable.
line_items_taxable_amount STRING Taxable amount of the line.
line_items_title STRING Product title.
line_items_total_price STRING Line total.
line_items_unit_price STRING Price per unit.
line_items_unit_price_includes_tax BOOLEAN Whether unit price includes tax.
order_attributes_name STRING Order attribute name.
order_attributes_value STRING Order attribute value.
processed_at TIMESTAMP When the order was processed.
scheduled_at TIMESTAMP When the order was scheduled.
shipping_address_address1 STRING Shipping street address.
shipping_address_city STRING Shipping city.
shipping_address_country_code STRING Shipping country (ISO 3166).
shipping_address_first_name STRING Shipping first name.
shipping_address_last_name STRING Shipping last name.
shipping_address_province STRING Shipping state / province.
shipping_address_zip STRING Shipping postal code.
shipping_lines_code STRING Shipping rate code.
shipping_lines_price STRING Shipping price.
shipping_lines_source STRING Shipping rate source.
shipping_lines_taxable BOOLEAN Whether shipping is taxable.
shipping_lines_title STRING Shipping rate title.
status STRING Order status.
subtotal_price STRING Subtotal before tax and shipping.
tags STRING Comma-separated tags.
tax_lines_price STRING Tax amount.
tax_lines_rate STRING Tax rate.
tax_lines_title STRING Tax name.
taxable BOOLEAN Whether the order is taxable.
total_discounts STRING Total discounts.
total_duties STRING Total duties.
total_line_items_price STRING Sum of line item prices.
total_price STRING Order total.
total_refunds STRING Total refunded.
total_tax STRING Total tax.
total_weight_grams NUMERIC Total weight in grams.
type STRING Order type (checkout or recurring).
updated_at TIMESTAMP Last update; replication key.

Subscriptions

Purpose: one row per subscription contract, with its product, price, billing interval and lifecycle status. Use it for active subscriber counts, MRR, churn and cancellation-reason analysis.

API: GET /subscriptions · Incremental on updated_at

Column Type Description
id NUMERIC Recharge subscription ID (primary key).
address_id NUMERIC Address the subscription ships to.
customer_id NUMERIC Subscriber's customer ID.
cancellation_reason STRING Reason selected at cancellation.
cancellation_reason_comments STRING Free-text cancellation comments.
cancelled_at TIMESTAMP When the subscription was cancelled.
charge_interval_frequency NUMERIC Units between charges.
created_at TIMESTAMP When the subscription was created.
external_product_id_ecommerce STRING Shopify product ID.
external_variant_id_ecommerce STRING Shopify variant ID.
has_queued_charges BOOLEAN Whether charges are queued.
is_prepaid BOOLEAN Whether the plan is prepaid.
is_skippable BOOLEAN Whether shipments can be skipped.
is_swappable BOOLEAN Whether the product can be swapped.
max_retries_reached BOOLEAN Whether payment retries are exhausted.
order_interval_frequency NUMERIC Units between orders.
order_interval_unit STRING Interval unit (day, week, month).
presentment_currency STRING Currency shown to the customer.
price STRING Price per unit.
product_title STRING Product title.
properties_name STRING Subscription property name.
properties_value STRING Subscription property value.
quantity NUMERIC Units per shipment.
sku STRING SKU.
sku_override BOOLEAN Whether the SKU is overridden.
status STRING active, cancelled or expired.
updated_at TIMESTAMP Last update; replication key.

Charges

Purpose: one row per payment attempt, scheduled or processed, with amounts, taxes and line items. Use it for billing success and failure rates, upcoming revenue forecasts and refund tracking.

API: GET /charges · Incremental on updated_at

Column Type Description
id NUMERIC Recharge charge ID (primary key).
address_id NUMERIC Address the charge ships to.
billing_address_address1 STRING Billing street address.
billing_address_city STRING Billing city.
billing_address_country_code STRING Billing country (ISO 3166).
billing_address_first_name STRING Billing first name.
billing_address_last_name STRING Billing last name.
billing_address_phone STRING Billing phone.
billing_address_province STRING Billing state / province.
billing_address_zip STRING Billing postal code.
client_details_browser_ip STRING Browser IP at checkout.
client_details_user_agent STRING Browser user agent at checkout.
created_at TIMESTAMP When the charge was created.
currency STRING Currency code (ISO 4217).
customer_id NUMERIC Recharge customer ID.
customer_email STRING Customer email.
customer_external_customer_id_ecommerce STRING Shopify customer ID.
customer_hash STRING Recharge customer hash.
external_order_id_ecommerce STRING Shopify order ID.
external_transaction_id_payment_processor STRING Payment processor transaction reference.
has_uncommitted_changes BOOLEAN Whether changes are pending commit.
line_items_purchase_item_id NUMERIC Subscription or one-time item ID.
line_items_external_product_id_ecommerce STRING Shopify product ID.
line_items_external_variant_id_ecommerce STRING Shopify variant ID.
line_items_images_large STRING Large product image URL.
line_items_images_medium STRING Medium product image URL.
line_items_images_original STRING Original product image URL.
line_items_images_small STRING Small product image URL.
line_items_original_price STRING Price before discounts.
line_items_properties_name STRING Line item property name.
line_items_properties_value STRING Line item property value.
line_items_purchase_item_type STRING subscription or onetime.
line_items_quantity NUMERIC Units charged.
line_items_sku STRING SKU.
line_items_tax_due STRING Tax due on the line.
line_items_taxable BOOLEAN Whether the line is taxable.
line_items_taxable_amount STRING Taxable amount of the line.
line_items_title STRING Product title.
line_items_total_price STRING Line total.
line_items_unit_price STRING Price per unit.
line_items_unit_price_includes_tax BOOLEAN Whether unit price includes tax.
line_items_variant_title STRING Variant title.
order_attributes_name STRING Order attribute name.
order_attributes_value STRING Order attribute value.
orders_count NUMERIC Orders created from the charge.
original_scheduled_at DATE Original scheduled date before any reschedule.
payment_processor STRING Payment processor used.
processed_at TIMESTAMP When the charge was processed.
scheduled_at DATE Scheduled charge date.
shipping_address_address1 STRING Shipping street address.
shipping_address_city STRING Shipping city.
shipping_address_country_code STRING Shipping country (ISO 3166).
shipping_address_first_name STRING Shipping first name.
shipping_address_last_name STRING Shipping last name.
shipping_address_phone STRING Shipping phone.
shipping_address_province STRING Shipping state / province.
shipping_address_zip STRING Shipping postal code.
shipping_lines_code STRING Shipping rate code.
shipping_lines_price STRING Shipping price.
shipping_lines_source STRING Shipping rate source.
shipping_lines_status STRING Shipping line status.
shipping_lines_taxable BOOLEAN Whether shipping is taxable.
shipping_lines_title STRING Shipping rate title.
status STRING Charge status (success, error, queued and so on).
subtotal_price STRING Subtotal before tax and shipping.
tags STRING Comma-separated tags.
taxable BOOLEAN Whether the charge is taxable.
taxes_included BOOLEAN Whether prices include tax.
total_discounts STRING Total discounts.
total_duties STRING Total duties.
total_line_items_price STRING Sum of line item prices.
total_price STRING Charge total.
total_refunds STRING Total refunded.
total_tax STRING Total tax.
total_weight_grams NUMERIC Total weight in grams.
type STRING Charge type (checkout or recurring).
updated_at TIMESTAMP Last update; replication key.

Customers

Purpose: one row per subscriber, with contact details, subscription counts and payment-method health. Use it for subscriber segmentation, lifetime value and dunning (failed-payment) monitoring.

API: GET /customers · Incremental on updated_at

Column Type Description
id NUMERIC Recharge customer ID (primary key).
apply_credit_to_next_checkout_charge BOOLEAN Store credit applies to the next checkout charge.
apply_credit_to_next_recurring_charge BOOLEAN Store credit applies to the next recurring charge.
created_at TIMESTAMP When the customer was created.
email STRING Customer email.
external_customer_id_ecommerce STRING Shopify customer ID.
first_charge_processed_at TIMESTAMP First successful charge.
first_name STRING First name.
has_payment_method_in_dunning BOOLEAN Payment method is in dunning (retry).
has_valid_payment_method BOOLEAN Customer has a valid payment method.
hash STRING Recharge customer hash.
last_name STRING Last name.
phone STRING Phone number.
subscription_related_charge_streak NUMERIC Consecutive subscription charges.
subscriptions_active_count NUMERIC Active subscriptions.
subscriptions_total_count NUMERIC All subscriptions ever created.
tax_exempt BOOLEAN Customer is tax exempt.
updated_at TIMESTAMP Last update; replication key.

Discounts

Purpose: one row per discount code, with its value, status and usage rules. Use it to measure promotion adoption and check which channels and customers a code applies to.

API: GET /discounts · Incremental on updated_at

Column Type Description
id NUMERIC Recharge discount ID (primary key).
applies_to_purchase_item_type STRING Item type the discount applies to.
channel_settings_api_can_apply BOOLEAN Can be applied through the API.
channel_settings_checkout_page_can_apply BOOLEAN Can be applied on the checkout page.
channel_settings_customer_portal_can_apply BOOLEAN Can be applied in the customer portal.
channel_settings_merchant_portal_can_apply BOOLEAN Can be applied in the merchant portal.
code STRING Discount code.
created_at TIMESTAMP When the discount was created.
external_discount_id_ecommerce STRING Shopify discount ID.
external_discount_source STRING Source of the external discount.
starts_at TIMESTAMP When the discount becomes active.
status STRING Discount status.
updated_at TIMESTAMP Last update; replication key.
usage_limits_first_time_customer_restriction BOOLEAN Limited to first-time customers.
usage_limits_one_application_per_customer BOOLEAN One use per customer.
value STRING Discount amount.
value_type STRING percentage or fixed_amount.

Onetimes

Purpose: one row per one-time product added to a subscriber's next charge. Use it to size add-on and upsell revenue separate from recurring revenue.

API: GET /onetimes · Incremental on updated_at (cancelled items included)

Column Type Description
id NUMERIC Recharge one-time ID (primary key).
address_id NUMERIC Address the item ships to.
customer_id NUMERIC Customer who added the item.
created_at TIMESTAMP When the item was added.
external_product_id_ecommerce STRING Shopify product ID.
external_variant_id_ecommerce STRING Shopify variant ID.
is_cancelled BOOLEAN Whether the item was cancelled.
next_charge_scheduled_at DATE Charge date the item ships with.
presentment_currency STRING Currency shown to the customer.
price STRING Item price.
product_title STRING Product title.
quantity NUMERIC Units.
sku_override BOOLEAN Whether the SKU is overridden.
updated_at TIMESTAMP Last update; replication key.
variant_title STRING Variant title.

Addresses

Purpose: one row per customer shipping address, linked to a payment method. Use it for delivery-region analysis, gift-subscription flags and joining subscriptions to locations.

API: GET /addresses · Incremental on updated_at

Column Type Description
id NUMERIC Recharge address ID (primary key).
customer_id NUMERIC Owning customer.
payment_method_id NUMERIC Payment method used for this address.
address1 STRING Street address.
city STRING City.
country_code STRING Country (ISO 3166).
created_at TIMESTAMP When the address was created.
first_name STRING Recipient first name.
is_gift BOOLEAN Whether the address is a gift recipient.
last_name STRING Recipient last name.
order_attributes_name STRING Order attribute name.
order_attributes_value STRING Order attribute value.
phone STRING Phone number.
presentment_currency STRING Currency shown to the customer.
province STRING State / province.
shipping_lines_conserved_code STRING Saved shipping rate code.
shipping_lines_conserved_price STRING Saved shipping price.
shipping_lines_conserved_title STRING Saved shipping rate title.
updated_at TIMESTAMP Last update; replication key.
zip STRING Postal code.

Collections

Purpose: reference records for product collections that Recharge uses in subscription and discount rules. Use it to group products when reporting.

API: GET /collections · Full load

Column Type Description
created_at DATETIME When the record was created.
customer_id NUMERIC Related customer ID.
description STRING Record description.
id NUMERIC Recharge record ID (primary key).
object_class STRING Class of the object affected.
object_id NUMERIC ID of the object affected.
source STRING Origin of the record.
verb STRING Action performed.

Retention_Strategies

Purpose: the save offers and prevention messages shown to a subscriber who starts to cancel, keyed by cancellation reason. Use it with Subscriptions to judge which offers reduce churn.

API: GET /retention_strategies · Full load

Column Type Description
cancellation_flow_type STRING Type of cancellation flow.
cancellation_reason STRING Cancellation reason the strategy targets.
created_at DATETIME When the strategy was created.
id NUMERIC Recharge strategy ID (primary key).
prevention_text STRING Retention message shown to the customer.
reason STRING Reason label.
updated_at DATETIME Last update.

Events

Purpose: an audit log of changes to Recharge objects (who or what changed which object, and when). Use it for customer-activity timelines and for tracing when a subscription changed state.

API: GET /events · Incremental on created_at, 6 days of history, loaded in 30-minute windows

Column Type Description
created_at DATETIME When the event occurred.
customer_id NUMERIC Related customer ID.
description STRING Event description.
id NUMERIC Recharge event ID (primary key).
object_class STRING Class of the object changed.
object_id NUMERIC ID of the object changed.
source STRING What triggered the event.
verb STRING Action performed (created, updated and so o
payments schema

Related Articles

Table of Contents

Tables supported Orders Subscriptions Charges Customers Discounts Onetimes Addresses Collections Retention_Strategies Events