Recharge: Most-used fields

The table below gives information about most-used fields that you can import from Recharge. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name	Adverity UI name	Description	Use in Adverity
address_id	address_id	The unique numeric identifier for the shipping address associated with the charge or onetime purchase.	dimension
analytics_data	analytics_data	An object containing analytics data, such as Urchin Tracking Module (UTM) parameters, associated with a record.	dimension
analytics_data_utm_param.utm_campaign	analytics_data_utm_param.utm_campaign	The Urchin Tracking Module (UTM) parameter that identifies a specific product promotion or strategic campaign for marketing efforts.	dimension
analytics_data_utm_param.utm_content	analytics_data_utm_param.utm_content	The Urchin Tracking Module (UTM) parameter that differentiates similar content or links within the same ad.	dimension
analytics_data_utm_param.utm_data_source	analytics_data_utm_param.utm_data_source	The Urchin Tracking Module (UTM) parameter indicating the source of the analytics data.	dimension
analytics_data_utm_param.utm_medium	analytics_data_utm_param.utm_medium	The Urchin Tracking Module (UTM) parameter that identifies the medium through which the user arrived, such as ‘email’ or ‘cpc’.	dimension
analytics_data_utm_param.utm_source	analytics_data_utm_param.utm_source	The Urchin Tracking Module (UTM) parameter that identifies the source of traffic, such as ‘google’ or ‘newsletter’.	dimension
analytics_data_utm_param.utm_term	analytics_data_utm_param.utm_term	The Urchin Tracking Module (UTM) parameter that identifies paid search keywords.	dimension
analytics_data_utm_param.utm_timestamp	analytics_data_utm_param.utm_timestamp	The Urchin Tracking Module (UTM) parameter indicating the timestamp of the campaign event.	dimension
apply_credit_to_next_recurring_charge	apply_credit_to_next_recurring_charge	A boolean that indicates whether Recharge credits will be applied to the next recurring charge.	dimension
billing_address1	billing_address1	The first line of the billing address.	dimension
billing_address2	billing_address2	Any additional information for the billing address.	dimension
billing_city	billing_city	The city associated with the billing address.	dimension
billing_company	billing_company	The company name associated with the billing address.	dimension
billing_country_code	billing_country_code	The 2-letter country code for the billing address.	dimension
billing_first_name	billing_first_name	The first name on the billing address.	dimension
billing_last_name	billing_last_name	The last name on the billing address.	dimension
billing_phone	billing_phone	The phone number associated with the billing address.	dimension
billing_province	billing_province	The state or province associated with the billing address.	dimension
billing_zip	billing_zip	The zip or postal code associated with the billing address.	dimension
cancellation_reason	cancellation_reason	The reason provided when a subscription is cancelled.	dimension
cancellation_reason_comments	cancellation_reason_comments		dimension
cancelled_at	cancelled_at	The date and time when the subscription was cancelled.	dimension
charge.id	charge.id	The unique numeric identifier for the Charge resulting from processing a Checkout.	metric
charge.status	charge.status	The status of the Charge. Possible values include success, error, queued, skipped, refunded, partially_refunded, pending_manual_payment, and pending.	dimension
charge_interval_frequency	charge_interval_frequency	The frequency of the billing interval for a subscription charge.	metric
client_browser_ip	client_browser_ip	The IP address of the client’s browser recorded during the transaction.	dimension
client_user_agent	client_user_agent	The user agent string of the client’s browser recorded during the transaction.	dimension
created_at	created_at	The date and time when the record was created.	dimension
created_at_date	created_at_date	The date and time when the record (e.g., charge, customer, order, or subscription) was initially created in the system.	dimension
currency	currency	The three-letter code of the currency for the charge or checkout, such as USD.	dimension
customer.analytics_data	customer.analytics_data	An object containing analytics data associated with the customer, such as UTM parameters.	dimension
customer.apply_credit_to_next_recurring_charge	customer.apply_credit_to_next_recurring_charge	A boolean that indicates whether Recharge credits will be applied to the customer’s next recurring charge.	dimension
customer.created_at	customer.created_at	The date and time when the customer record was created.	dimension
customer.email	customer.email	The email address of the customer.	dimension
customer.first_charge_processed_at	customer.first_charge_processed_at	The date when the first charge was successfully processed for the customer.	dimension
customer.first_name	customer.first_name	The first name of the customer.	dimension
customer.has_payment_method_in_dunning	customer.has_payment_method_in_dunning	A boolean indicating if the customer has a payment method currently in a dunning state (e.g., due to a failed charge).	dimension
customer.has_valid_payment_method	customer.has_valid_payment_method	A boolean indicating if the customer has a valid payment method on file.	dimension
customer.hash	customer.hash	The unique string identifier used in a customer’s portal link.	dimension
customer.id	customer.id	The unique numeric identifier for the Customer.	metric
customer.last_name	customer.last_name	The last name of the customer.	dimension
customer.phone	customer.phone	The phone number of the customer.	metric
customer.subscription_related_charge_streak	customer.subscription_related_charge_streak	The number of consecutive subscription-related charges processed for this customer while they have at least one active subscription. This resets to zero when all subscriptions are cancelled or expired.	metric
customer.subscriptions_active_count	customer.subscriptions_active_count	The total number of active subscriptions associated with the customer’s addresses.	metric
customer.subscriptions_total_count	customer.subscriptions_total_count	The total number of subscriptions ever created for the customer, including active, cancelled, or expired.	metric
customer.tax_exempt	customer.tax_exempt	A boolean indicating whether the customer is exempt from sales tax.	dimension
customer.updated_at	customer.updated_at	The date and time when the customer record was last updated.	dimension
customer_external_customer_id.ecommerce	customer_external_customer_id.ecommerce	The unique identifier for the customer record in the external e-commerce platform.	dimension
customer_id	customer_id	The unique numeric identifier for the customer.	dimension
discount.code	discount.code	The code used to apply the discount.	dimension
discount.id	discount.id	The unique numeric identifier for the discount.	metric
discount.value	discount.value	The discounted value to be applied.	metric
discount.value_type	discount.value_type	The type of discount mechanic. Possible values include fixed_amount, percentage, or shipping.	dimension
email	email	The email address of the customer.	dimension
error	error	A textual description of an error, often returned directly from the payment processor.	dimension
error_type	error_type	A structured reason why the charge failed, such as ‘CUSTOMER_NEEDS_TO_UPDATE_CARD’.	dimension
expire_after_specific_number_of_charges	expire_after_specific_number_of_charges	The number of charges after which a subscription will automatically expire.	dimension
external_customer_id	external_customer_id	An object containing external IDs for the customer record, such as the e-commerce platform’s customer ID.	dimension
external_product_id	external_product_id	The unique identifier of the product as it appears in the integrated external e-commerce platform.	dimension
external_variant_id	external_variant_id	The unique identifier of the product variant as it appears in the integrated external e-commerce platform.	dimension
first_charge_processed_at	first_charge_processed_at	The date and time when the first charge was processed for the customer.	dimension
first_name	first_name	The first name of the customer.	dimension
has_payment_method_in_dunning	has_payment_method_in_dunning	A boolean that indicates if the customer has a payment method that is currently in dunning (i.e., has experienced a failed charge).	dimension
has_uncommitted_changes	has_uncommitted_changes	Specifies whether the Charge is scheduled for a regeneration (if the Subscription related to the charge was updated recently using commit=false).	dimension
has_valid_payment_method	has_valid_payment_method	A boolean indicating whether the customer has a valid payment method on file.	dimension
hash	hash	The unique string identifier used in a customer’s portal link.	dimension
id	id	The unique numeric identifier for the object.	dimension
is_prepaid	is_prepaid	A boolean indicating if the subscription associated with the line item is prepaid.	dimension
is_skippable	is_skippable	A boolean indicating if a subscription’s upcoming charge can be skipped by the customer.	dimension
is_swappable	is_swappable		dimension
last_name	last_name	The last name of the customer.	dimension
line_items.external_inventory_policy	line_items.external_inventory_policy	The inventory policy of the line item as it appears in the external e-commerce platform.	dimension
line_items.grams	line_items.grams	The weight of the line item in grams.	metric
line_items.handle	line_items.handle	A unique human-readable string for the product or variant, often used in URLs.	dimension
line_items.original_price	line_items.original_price	The original price of the individual line item before discounts or taxes.	metric
line_items.purchase_item_id	line_items.purchase_item_id	The unique identifier for the purchase item (e.g., a subscription or onetime product) associated with the line item.	dimension
line_items.purchase_item_type	line_items.purchase_item_type	The type of purchase item for the line, such as ‘subscription’ or ‘onetime’.	dimension
line_items.quantity	line_items.quantity	The quantity of the item in the line.	metric
line_items.sku	line_items.sku	The Stock Keeping Unit (SKU) for the product variant.	metric
line_items.tax_due	line_items.tax_due	The total amount of tax due for this line item.	metric
line_items.tax_lines	line_items.tax_lines	An array of tax line objects that apply to the line item, detailing individual tax components.	dimension
line_items.taxable	line_items.taxable	A boolean indicating whether the line item is taxable.	dimension
line_items.taxable_amount	line_items.taxable_amount	The amount of the line item that is subject to tax.	metric
line_items.title	line_items.title	The title of the product or item in the line.	dimension
line_items.total_price	line_items.total_price	The total price of the line item, including any discounts and taxes.	metric
line_items.unit_price	line_items.unit_price	The price of a single unit of the item in the line.	metric
line_items.unit_price_includes_tax	line_items.unit_price_includes_tax	A boolean indicating whether the unit price includes tax.	dimension
line_items.variant_title	line_items.variant_title	The title of the product variant in the line item.	dimension
line_items_external_product_id.ecommerce	line_items_external_product_id.ecommerce	The product ID for the line item as it appears in the external e-commerce platform.	dimension
line_items_external_variant_id.ecommerce	line_items_external_variant_id.ecommerce	The variant ID for the line item as it appears in the external e-commerce platform.	dimension
line_items_images.large	line_items_images.large	The URL to the large size image of the line item’s product.	dimension
line_items_images.medium	line_items_images.medium	The URL to the medium size image of the line item’s product.	dimension
line_items_images.original	line_items_images.original	The URL to the original size image of the line item’s product.	dimension
line_items_images.small	line_items_images.small	The URL to the small size image of the line item’s product.	dimension
line_items_properties.name	line_items_properties.name	The name of a custom property associated with the line item.	dimension
line_items_properties.value	line_items_properties.value	The value of a custom property associated with the line item.	dimension
line_items_tax_lines	line_items_tax_lines	An array of tax line objects that apply to the line item, detailing individual tax components.	dimension
next_charge_scheduled_at	next_charge_scheduled_at	The date and time when the next recurring charge for the subscription is scheduled.	dimension
note	note	Custom notes associated with the object, such as a Charge, Checkout, Address, or Credit Adjustment.	dimension
order_attributes.name	order_attributes.name	The name of a custom attribute associated with the order.	dimension
order_attributes.value	order_attributes.value	The value of a custom attribute associated with the order.	dimension
order_day_of_month	order_day_of_month	The specific day of the month when the recurring order is processed.	dimension
order_day_of_week	order_day_of_week	The specific day of the week when the recurring order is processed.	dimension
order_interval_frequency	order_interval_frequency	The frequency of the interval at which orders are placed.	metric
order_interval_unit	order_interval_unit	The unit of time for the order interval (e.g., day, week, month, year).	dimension
orders_count	orders_count	The number of orders generated from this charge (greater than 1 for prepaid subscriptions).	metric
payment_processor	payment_processor	The name of the payment processor used for the charge or checkout.	dimension
phone	phone	The customer’s phone number.	dimension
presentment_currency	presentment_currency	The currency in which the subscription contract or charges are presented.	dimension
price	price	The price of an individual item or component within a charge or subscription.	metric
processed_at	processed_at	The date and time when the financial transaction was processed.	dimension
product_title	product_title	The title or name of the product associated with a line item.	dimension
properties	properties	An array of custom name-value pairs for additional attributes or metadata related to a line item.	dimension
quantity	quantity	The number of units for a specific product or item.	metric
retry_date	retry_date	The date when the next attempt to process a failed charge will be placed.	dimension
scheduled_at	scheduled_at	The date and time of when the Charge is/was scheduled to process.	dimension
shipping_address1	shipping_address1	The first line of the shipping address.	dimension
shipping_address2	shipping_address2	Any additional information for the shipping address.	dimension
shipping_city	shipping_city	The city associated with the shipping address.	dimension
shipping_company	shipping_company	The company name associated with the shipping address.	dimension
shipping_country_code	shipping_country_code	The 2-letter country code for the shipping address.	dimension
shipping_first_name	shipping_first_name	The first name on the shipping address.	dimension
shipping_last_name	shipping_last_name	The last name on the shipping address.	dimension
shipping_lines.code	shipping_lines.code	The code of the shipping rate applied.	dimension
shipping_lines.price	shipping_lines.price	The price of the shipping rate.	metric
shipping_lines.source	shipping_lines.source	The source of the shipping rate, e.g., ‘shopify’.	dimension
shipping_lines.tax_lines	shipping_lines.tax_lines	An array of tax line objects that apply to the shipping line.	dimension
shipping_lines.taxable	shipping_lines.taxable	A boolean indicating whether the shipping line is taxable.	dimension
shipping_lines.title	shipping_lines.title	The title or name of the shipping rate.	dimension
shipping_phone	shipping_phone	The phone number associated with the shipping address.	dimension
shipping_province	shipping_province	The state or province associated with the shipping address.	dimension
shipping_zip	shipping_zip	The zip or postal code associated with the shipping address.	dimension
sku	sku	The Stock Keeping Unit (SKU) of the product variant.	metric
status	status	The current status of the object. For Charges, possible values include success, error, queued, skipped, refunded, partially_refunded, pending_manual_payment, pending. For Discounts, values can be enabled, disabled, or fully_disabled.	dimension
subscription_related_charge_streak	subscription_related_charge_streak	The number of consecutive subscription-related charges processed for this customer, while they retain at least one active subscription. This value resets to zero if all subscriptions are cancelled or expired.	metric
subscriptions_active_count	subscriptions_active_count	The number of active subscriptions associated with the customer’s addresses.	metric
subscriptions_total_count	subscriptions_total_count	The total number of subscriptions created on addresses associated with the customer.	metric
subtotal_price	subtotal_price	The combined price of all line items without taxes and shipping.	metric
tags	tags	A comma-separated list of tags applied to the Charge.	dimension
tax_exempt	tax_exempt	A boolean indicating whether the customer is tax exempt.	dimension
tax_lines	tax_lines	An array of tax line objects that apply to the Charge or Checkout, detailing individual tax components.	dimension
taxable	taxable	A boolean indicator of whether the Charge or Checkout items are taxable.	dimension
taxes_included	taxes_included	A boolean indicating whether taxes are included in the order subtotal or item prices.	dimension
total_discounts	total_discounts	The sum of all discounts applied to the Charge.	metric
total_duties	total_duties	The total amount of customs duties and import taxes applied to an order or charge.	metric
total_line_items_price	total_line_items_price	The total price of all line items within the Charge.	metric
total_price	total_price	The sum of all prices for all items in the Charge or Checkout, including taxes and discounts.	metric
total_refunds	total_refunds	The sum of all refunds that were applied to the Charge.	metric
total_tax	total_tax	The total tax due associated with the Charge or charged on the Checkout.	metric
total_weight_grams	total_weight_grams	The total weight of the Charge’s line items in grams.	metric
type	type	The type of the object. For Charges, possible values are ‘checkout’ or ‘recurring’. For Collections, ‘manual’. For Credit Accounts, ‘reward’ or ‘manual’. For Discounts, ‘fixed_amount’, ‘percentage’, or ‘shipping’.	dimension
updated_at	updated_at	The date and time when the record was last updated.	dimension
variant_title	variant_title	The title or name of the specific product variant.	dimension