Choose a version:

payments

The payments schema captures payment activity at the transaction level. It's the payment-side view of money moving in and out, connected back to orders, customers, POS, gift cards, and channels.

Anchor to Use casesUse cases

Payment movement: Show gross_payments, refunded_payments, and net_payments by month to explain payment movement for a period.
POS reporting: Group net_payments_excluding_gift_cards by pos_location_name to compare payment performance across your physical locations.
Order coverage: Use orders_with_transactions and transactions together to distinguish order coverage from transaction volume.
Gift card activity: Report redeemed_gift_card_value and refunded_gift_card_value by gift_card_id when analyzing gift card payment activity.

Examples

ShopifyQL

View in adminView query results in the ShopifyQL editor

FROM payments

SHOW gross_payments, refunded_payments, net_payments,

net_payments_excluding_gift_cards

GROUP BY is_shop_pay_transaction WITH TOTALS

TIMESERIES day

SINCE this_month UNTIL today

COMPARE TO previous_month

ORDER BY day ASC

VISUALIZE net_payments TYPE line

Examples

Description

Chart daily `net_payments` this month, split by Shop Pay and other payment methods. This example uses [`COMPARE TO previous_month`](/docs/api/shopifyql/latest/syntax/compare-to) to benchmark each day against the same day last month.

ShopifyQL

FROM payments
  SHOW gross_payments, refunded_payments, net_payments,
    net_payments_excluding_gift_cards
  GROUP BY is_shop_pay_transaction WITH TOTALS
  TIMESERIES day
  SINCE this_month UNTIL today
  COMPARE TO previous_month
  ORDER BY day ASC
VISUALIZE net_payments TYPE line

Description

Break down last quarter's `net_payments` by payment method, card type, and wallet. This example uses [`WHERE`](/docs/api/shopifyql/latest/syntax/where) `transaction_kind = 'sale'` to exclude refunds from the totals.

ShopifyQL

FROM payments
  SHOW net_payments, transactions, orders_with_transactions
  WHERE transaction_kind = 'sale'
  GROUP BY payment_method, credit_card_type, digital_wallet WITH TOTALS,
    GROUP_TOTALS
  DURING last_quarter
  ORDER BY net_payments DESC
  LIMIT 50
VISUALIZE net_payments TYPE donut

Description
Track daily `transaction_amount` from completed sales last month, alongside the value redeemed from gift cards. This example uses [`WHERE`](/docs/api/shopifyql/latest/syntax/where) `transaction_kind = 'sale'` to keep refunds and non-sale transactions out of the daily total.
ShopifyQL
```
FROM payments
  SHOW redeemed_gift_card_value, refunded_gift_card_value, transaction_amount
  WHERE transaction_kind = 'sale'
  TIMESERIES day WITH TOTALS
  DURING last_month
  ORDER BY day ASC
VISUALIZE transaction_amount TYPE line
```
Description
Track weekly `rounded_net_payments` across this quarter. This example uses [`TIMESERIES week`](/docs/api/shopifyql/latest/syntax/timeseries) to roll daily payments up into one point per week.
ShopifyQL
```
FROM payments
  SHOW rounded_net_payments
  TIMESERIES week
  DURING this_quarter
  ORDER BY week ASC
VISUALIZE rounded_net_payments TYPE line
```

Anchor to MetricsMetrics

Counts and calculations that let you track key business indicators. Metrics show up as the columns when queried.

Metrics you can use when querying FROM payments.

Anchor to cash_rounding cash_rounding: Positive values mean cash payments are rounded up, and negative values mean they're rounded down, in your store's currency.
Anchor to gross_payments gross_payments: Amount of payments before any refunds
Anchor to net_payments net_payments: Amount of payments after any refunds
Anchor to net_payments_excluding_gift_cards net_payments_excluding_gift_cards: Amount of payments after any refunds, excluding amount redeemed from gift cards
Anchor to orders_with_transactions orders_with_transactions: Orders are included when they have a sale or capture transaction.
Anchor to redeemed_gift_card_value redeemed_gift_card_value: Includes successful purchases where a gift card was redeemed, in your store's currency.
Anchor to refunded_gift_card_value refunded_gift_card_value: Includes successful refunds returned to gift cards, in your store's currency.
Anchor to refunded_payments refunded_payments: Amount of refunded payments
Anchor to rounded_net_payments rounded_net_payments: The amount of payments after refunds, with cash payments rounded to the nearest currency unit, in your store's currency. Use rounded_net_payments to review payment value when cash rounding matters.
Anchor to transaction_amount transaction_amount: Amount of all payment transactions
Anchor to transactions transactions: Number of payment transactions

MONEY

A monetary amount representing currency values such as prices, revenue, costs, and discounts.

INTEGER

A whole number without decimal places, used for counts, quantities, and other discrete numeric values.

Anchor to DimensionsDimensions

Attributes of your data that let you look more granularly at aspects of the data. Group and filter by dimensions to shape the rows your query returns.

Dimensions you can use when querying FROM payments.

Anchor to billing_address_id billing_address_id: The unique Shopify identifier for the billing address. Use billing_address_id with billing_city, billing_region, or billing_country to show location labels.
Anchor to channel_id channel_id: Shopify identifier for the sales channel (multi-channel app)
Anchor to credit_card_tier credit_card_tier: Values are Standard and Premium.
Anchor to credit_card_type credit_card_type: For refunds, captures, or other related payment activity, credit_card_type reflects the card type from the original card payment.
Anchor to customer_id customer_id: The unique Shopify identifier for the customer tied to the transaction. Use customer_id to break results down by customer or filter to a specific customer. Use it with customer_name or customer_email to show readable labels.
Anchor to day day: Based on when the payment transaction happened.
Anchor to day_of_week day_of_week: The day of the week a transaction happened, with values Monday through Sunday.
Anchor to digital_wallet digital_wallet: Digital wallet used for the transaction
Anchor to gift_card_id gift_card_id: The unique Shopify identifier for the gift card used in the transaction. Use gift_card_id to filter to payments involving a specific gift card.
Anchor to hour hour: Based on when the payment transaction happened.
Anchor to hour_of_day hour_of_day: The hour of day a transaction happened, with values 0 through 23.
Anchor to is_shop_channel_transaction is_shop_channel_transaction: Label specifying whether the transaction was processed through the Shop channel
Anchor to is_shop_pay_transaction is_shop_pay_transaction: Shop Cash payments are included as Shop Pay transactions.
Anchor to minute minute: Based on when the payment transaction happened.
Anchor to month month: Based on when the payment transaction happened.
Anchor to month_of_year month_of_year: The month of the year a transaction happened, with values 1 through 12.
Anchor to new_or_returning_customer new_or_returning_customer: A payment transaction tied to a customer's first order is New, and one tied to a later order is Returning.
Anchor to order_id order_id: The unique Shopify identifier for the order tied to the transaction. Use order_id with order_name to show the customer-facing order label.
Anchor to payment_card_bin payment_card_bin: Values are BINs that identify the card-issuing bank or institution.
Anchor to payment_card_issuer payment_card_issuer: The issuer of the payment card used for the transaction, such as a bank or card provider.
Anchor to payment_card_source payment_card_source: Values are Credit, Debit, Prepaid, and Unknown.
Anchor to payment_gateway payment_gateway: Values are gateway names such as Shopify Payments, Gift Card, Shop Pay Installments, and Cash.
Anchor to payment_method payment_method: Values are payment method names such as Card, PayPal, Klarna, and Gift Card.
Anchor to pos_location_id pos_location_id: The unique Shopify identifier for the physical retail location tied to the transaction. Use pos_location_id with pos_location_name to show readable retail location labels.
Anchor to pos_location_name pos_location_name: Name of your physical retail location
Anchor to quarter quarter: Based on when the payment transaction happened.
Anchor to second second: Based on when the payment transaction happened.
Anchor to shipping_address_id shipping_address_id: The unique Shopify identifier for the shipping address. Use shipping_address_id with shipping_city, shipping_region, or shipping_country to show location labels.
Anchor to shop_id shop_id: The unique Shopify identifier for your store. Use shop_id with shop_name to show readable store labels.
Anchor to staff_id staff_id: The unique Shopify identifier for the staff member associated with the transaction. Use staff_id with staff_member_name to show readable staff labels.
Anchor to transaction_currency transaction_currency: Currency of the transaction
Anchor to transaction_id transaction_id: The unique Shopify identifier for the transaction. Use transaction_id to filter to a specific payment transaction.
Anchor to transaction_kind transaction_kind: Transaction kinds include sale, authorization, capture, refund, etc.
Anchor to transaction_number transaction_number: Number of the transaction
Anchor to transaction_sale_type transaction_sale_type: Sale type of the transaction, such as Shop App or Shop Pay
Anchor to transaction_status transaction_status: Status of the transaction, such as success, pending, or failure
Anchor to week week: Based on when the payment transaction happened.
Anchor to week_of_year week_of_year: The week of the year a transaction happened, with values 1 through 53.
Anchor to year year: Based on when the payment transaction happened.
Anchor to billing_city billing_city: City of the billing address
Anchor to billing_company billing_company: B2B customer associated with the billing address
Anchor to billing_country billing_country: Country of the billing address (e.g., United States, Canada)
Anchor to billing_postal_code billing_postal_code: Postal code of the billing address
Anchor to billing_region billing_region: State or province of the billing address (e.g., California, Ontario)
Anchor to shop_name shop_name: Name of your store
Anchor to abandoned_checkout_date abandoned_checkout_date: Date the customer most recently abandoned a cart
Anchor to customer_account_status customer_account_status: The customer's account state, with values Declined, Disabled, Enabled, and Invited.
Anchor to customer_added_date customer_added_date: The day the customer record was added, reported in your store's time zone.
Anchor to customer_created_by_app_id customer_created_by_app_id: The Shopify identifier for the app that created the customer.
Anchor to customer_email customer_email: Email address of the customer
Anchor to customer_email_domain customer_email_domain: The part of the customer's email address after the @ symbol, such as gmail.com or your company's domain.
Anchor to customer_language customer_language: Language associated with the customer
Anchor to customer_name customer_name: Full name of the customer
Anchor to customer_email_subscription_status customer_email_subscription_status: The customer's email marketing subscription state, with values such as Invalid, Not subscribed, Pending, and Subscribed.
Anchor to customer_cities customer_cities <>: All cities in the customer's history of addresses
Anchor to customer_countries customer_countries <>: All countries from the customer's address history. Values are country codes such as US, CA, GB, and AU.
Anchor to customer_regions customer_regions <>: All states or provinces from the customer's address history. Values are region codes such as US-CA, US-NY, CA-ON, and GB-ENG.
Anchor to customer_amount_spent customer_amount_spent: The customer's all-time spend is shown in your store's currency.
Anchor to customer_last_order_date customer_last_order_date: The day the customer most recently placed an order, reported in your store's time zone.
Anchor to customer_number_of_orders customer_number_of_orders: Number of orders the customer has placed across all time
Anchor to first_order_sales_channel first_order_sales_channel: The sales channel where the customer's first order was placed, shown as a channel name such as Online Store or POS.
Anchor to customer_cohort_month customer_cohort_month: The month of the customer's first order, reported in your store's time zone.
Anchor to customer_cohort_quarter customer_cohort_quarter: The quarter of the customer's first order, reported in your store's time zone.
Anchor to customer_cohort_week customer_cohort_week: The week of the customer's first order, reported in your store's time zone.
Anchor to customer_first_order_date customer_first_order_date: The day the customer placed their first order, reported in your store's time zone.
Anchor to first_order_referring_channel first_order_referring_channel: Referring channel associated with the customer's first order
Anchor to first_order_traffic_type first_order_traffic_type: Type of traffic associated with the customer's first order
Anchor to first_order_has_subscription first_order_has_subscription: Whether the customer's first order included a subscription purchase, with values true and false.
Anchor to first_order_products first_order_products <>: Products bought together in the customer's first order
Anchor to predicted_spend_tier predicted_spend_tier: The customer's predicted spend tier for the next year, with values Low, Medium, and High.
Anchor to customer_sms_subscription_status customer_sms_subscription_status: The customer's SMS marketing subscription state, with values such as Not subscribed, Pending, Redacted, and Subscribed.
Anchor to customer_tag customer_tag: Tag associated with the customer
Anchor to customer_tags customer_tags <>: Set of tags associated with the customer
Anchor to rfm_group rfm_group: A customer relationship label based on recency, frequency, and monetary spend. Values include Champions, Loyal, Needs attention, and At risk.
Anchor to is_b2b_order is_b2b_order: Whether the order is a B2B order, with values true and false.
Anchor to is_canceled_order is_canceled_order: Whether the order is canceled, with values true and false.
Anchor to order_checkout_currency order_checkout_currency: The currency the buyer saw at checkout when placing the order. Values are currency codes such as USD, CAD, EUR, and GBP.
Anchor to order_fulfillment_status order_fulfillment_status: The order's fulfillment state, with values Fulfilled, Partial, Restocked, and Unfulfilled.
Anchor to order_includes_duties order_includes_duties: Whether the order includes duties, with values true and false.
Anchor to order_name order_name: The name or number of the order as the customer sees it.
Anchor to order_payment_status order_payment_status: The order's payment state, such as Authorized, Paid, Partially refunded, or Pending.
Anchor to order_sales_channel order_sales_channel: The sales channel where the order was placed, shown as a channel name such as Online Store or POS.
Anchor to order_sales_channel_id order_sales_channel_id: The unique Shopify identifier for the order's sales channel. Use order_sales_channel_id with order_sales_channel to show readable channel labels.
Anchor to is_shop_referral_order is_shop_referral_order: Whether the order was referred from the Shop app or shop.app, with values true and false.
Anchor to order_landing_page_path order_landing_page_path: Path of the first page of the user session that resulted in the order
Anchor to order_landing_page_url order_landing_page_url: First page of the user session that resulted in the order
Anchor to order_marketing_event_id order_marketing_event_id: Shopify identifier for the marketing event associated with the order
Anchor to order_referrer_domain order_referrer_domain: Domain of the site that led to the order
Anchor to order_referrer_name order_referrer_name: The readable name of the site that led to the order.
Anchor to order_referrer_path order_referrer_path: Path of the site that led to the order
Anchor to order_referrer_site order_referrer_site: Site that led to the order
Anchor to order_referrer_source order_referrer_source: The referrer type that led to the order, such as organic or email.
Anchor to order_referrer_url order_referrer_url: External page that referred a customer and led to the order
Anchor to order_utm_campaign order_utm_campaign: UTM name of the campaign associated with the order
Anchor to order_utm_content order_utm_content: The UTM content value associated with the order, often used to distinguish ads, links, or content variations.
Anchor to order_utm_medium order_utm_medium: The UTM medium associated with the order, such as email, social, or paid search.
Anchor to order_utm_source order_utm_source: The UTM source associated with the order, such as Google, Facebook, or a newsletter.
Anchor to order_utm_term order_utm_term: The UTM term associated with the order, often used for paid search keywords or other tracked terms.
Anchor to number_of_products_bought_together number_of_products_bought_together: Total unique products in the same order
Anchor to number_of_variants_bought_together number_of_variants_bought_together: The number of unique product variants in the same order, with each SKU counted a single time.
Anchor to products_bought_together products_bought_together <>: The product names that appear in the same order.
Anchor to products_bought_together_ids products_bought_together_ids <>: The Shopify product identifiers for products in the same order.
Anchor to variants_bought_together variants_bought_together <>: The product variant labels that appear in the same order, such as size, color, or style combinations.
Anchor to company_id company_id: The unique Shopify identifier for the company. Use company_id with company_name to show readable company labels.
Anchor to company_name company_name: Name of the company that placed the order
Anchor to company_location_id company_location_id: The unique Shopify identifier for the company location. Use company_location_id with company_location_name to show readable company location labels.
Anchor to company_location_name company_location_name: The company location or branch that placed the order
Anchor to referring_channel referring_channel: Marketing channel that referred the customer to place the order
Anchor to referring_medium referring_medium: The marketing medium that referred the customer to place the order, such as email, social, or search.
Anchor to referring_platform referring_platform: The marketing platform that referred the customer to place the order, such as Google, Facebook, or Instagram.
Anchor to traffic_type traffic_type: The type of traffic that led to the order, such as organic, paid, or direct.
Anchor to order_marketing_event_target order_marketing_event_target: The platform or channel where the marketing activity was deployed, such as Email, Facebook, Google, or Instagram.
Anchor to order_marketing_event_type order_marketing_event_type: The type of marketing activity that led to the order, such as Ad, Affiliate, Newsletter, or Retargeting. PLA means Product Listing Ads, and SEO means Search Engine Optimization.
Anchor to market market: Market you've defined in Shopify, like a geographical market or customer group
Anchor to markets markets <>: Markets or customer segments associated with the order
Anchor to order_cancellation_reason order_cancellation_reason: The reason specified for the order cancellation, such as Customer, Other, Fraud, or Inventory.
Anchor to order_risk_level order_risk_level: The fraud risk level Shopify assigned to the order, with values Low, Medium, High, None, and Pending.
Anchor to order_is_shopify_protect_covered order_is_shopify_protect_covered: Whether the order has met Shopify Protect fulfillment requirements, including proper shipping and tracking, with values true and false.
Anchor to order_is_shopify_protect_eligible order_is_shopify_protect_eligible: Whether the order qualifies for Shopify Protect, with values true and false.
Anchor to order_is_shopify_protect_protected order_is_shopify_protect_protected: Whether the order has full Shopify Protect coverage against fraud, with values true and false.
Anchor to order_tag order_tag: Tag associated with the order
Anchor to order_tags order_tags <>: Set of tags associated with the order
Anchor to agentic_referring_channel agentic_referring_channel: The AI agent or assistant that referred the session to your online store, with values ChatGPT, Google AI Mode and Gemini, Microsoft Copilot, and Shop.
Anchor to channel_handle channel_handle: Name of the marketing channel or platform that drove the marketing engagement
Anchor to marketing_activity_id marketing_activity_id: The unique Shopify identifier for the marketing activity. Use marketing_activity_id with marketing_activity_title to show readable activity labels.
Anchor to marketing_activity_status marketing_activity_status: Current status of the marketing activity (such as Active or Paused)
Anchor to marketing_activity_title marketing_activity_title: Name of the marketing activity
Anchor to marketing_activity_url_parameter_key marketing_activity_url_parameter_key: URL parameter key for the marketing activity
Anchor to marketing_activity_url_parameter_value marketing_activity_url_parameter_value: URL parameter value for the marketing activity
Anchor to marketing_automation_id marketing_automation_id: Unique ID that Shopify uses to identify the marketing automation
Anchor to marketing_delivery_channel marketing_delivery_channel: Channel through which the marketing activity is delivered
Anchor to marketing_event_id marketing_event_id: Unique identifier for the associated marketing event
Anchor to marketing_platform marketing_platform: The marketing platform that created the marketing activity, shown as a platform name.
Anchor to page_host page_host: The host name of the session landing page.
Anchor to page_path page_path: The path of the session landing page.
Anchor to page_url page_url: The URL of the first page viewed in the session.
Anchor to referrer_url referrer_url: External page that led to an online store session
Anchor to utm_campaign utm_campaign: UTM name of the campaign associated with the session
Anchor to utm_content utm_content: The UTM content value associated with the session, often used to distinguish ads, links, or content variations.
Anchor to utm_medium utm_medium: The UTM medium associated with the session, such as email, social, or paid search.
Anchor to utm_source utm_source: The UTM source associated with the session, such as Google, Facebook, or a newsletter.
Anchor to utm_term utm_term: The UTM term associated with the session, often used for paid search keywords or other tracked terms.
Anchor to pos_register_id pos_register_id: Identifier for the register at your physical retail location
Anchor to shipping_city shipping_city: City of the shipping address
Anchor to shipping_company shipping_company: Company of the shipping address
Anchor to shipping_country shipping_country: Country of the shipping address (e.g., United States, Canada)
Anchor to shipping_postal_code shipping_postal_code: Postal code of the shipping address
Anchor to shipping_region shipping_region: State or province of the shipping address (e.g., California, Ontario)
Anchor to staff_member_name staff_member_name: Name of the staff member associated with the order

IDENTITY

A unique identifier for a Shopify resource such as a customer, product, or order.

STRING

A sequence of characters representing text data.

DAY_TIMESTAMP

A date value truncated to day precision.

DAY_OF_WEEK

A day within a week, used for weekday-based grouping and filtering.

HOUR_TIMESTAMP

A timestamp truncated to hour precision.

HOUR_OF_DAY

An hour within a day, typically represented as an integer from 0 to 23.

BOOLEAN

A true or false value representing binary states.

MINUTE_TIMESTAMP

A timestamp truncated to minute precision.

MONTH_TIMESTAMP

A date value representing the start of a month.

MONTH_OF_YEAR

A month number within a year.

QUARTER_TIMESTAMP

A date value representing the start of a fiscal quarter.

SECOND_TIMESTAMP

A timestamp truncated to second precision.

WEEK_TIMESTAMP

A date value representing the start of a week.

WEEK_OF_YEAR

A week number within a year.

YEAR_TIMESTAMP

A date value representing the start of a year.

ARRAY

A list of values. The element type appears inside angle brackets, such as ARRAY<STRING>.

Anchor to MATCHES expressionsMATCHES expressions

Use these expressions inside a MATCHES filter to keep payments rows that have at least one related record matching the parameters. Each parameter filters on a dimension or metric of the related records.

Anchor to customer.orders_placed customer.orders_placed: Orders the customer placed, filterable by order date, source app, location, order count, and spend.
Anchor to customer.products_purchased customer.products_purchased: Products the customer bought, filterable by product ID, purchase date, quantity per order, and total quantity.
Anchor to customer.shopify_email.bounced customer.shopify_email.bounced: Emails that bounced for the customer, filterable by marketing activity, bounce date, and bounce count.
Anchor to customer.shopify_email.clicked customer.shopify_email.clicked: Emails the customer clicked, filterable by marketing activity, click date, and click count.
Anchor to customer.shopify_email.delivered customer.shopify_email.delivered: Emails delivered to the customer, filterable by marketing activity, delivery date, and delivery count.
Anchor to customer.shopify_email.marked_as_spam customer.shopify_email.marked_as_spam: Emails the customer marked as spam, filterable by marketing activity, spam-report date, and spam-report count.
Anchor to customer.shopify_email.opened customer.shopify_email.opened: Emails the customer opened, filterable by marketing activity, open date, and open count.
Anchor to customer.shopify_email.unsubscribed customer.shopify_email.unsubscribed: Email unsubscribe events for the customer, filterable by marketing activity, unsubscribe date, and unsubscribe count.
Anchor to customer.store_credit_accounts customer.store_credit_accounts: Store credit accounts for the customer, filterable by balance, currency, expiry date, and most recent credit date.
Anchor to customer.storefront_event.collection_viewed customer.storefront_event.collection_viewed: Collection pages the customer viewed, filterable by collection ID, view date, and view count.
Anchor to customer.storefront_event.product_viewed customer.storefront_event.product_viewed: Product pages the customer viewed, filterable by product ID, view date, and view count.
Anchor to customer.within_distance customer.within_distance: Customers with an address within a distance of a location, filterable by coordinates and radius.

PaymentsCustomerOrdersPlacedConditions

Fields you can use inside `customer.orders_placed MATCHES (...)` when querying `FROM payments`.

amount
Filter. Amount spent per order.
```
MONEY
```
app_id
Filter. App ID associated with the order.
```
IDENTITY
```
date
Filter. Date the order was placed.
```
TIMESTAMP
```
location_id
Filter. Location ID associated with the order.
```
IDENTITY
```
count
Metric. Number of orders placed.
```
INTEGER
```
sum_amount
Metric. Amount spent in the date range.
```
MONEY
```

TIMESTAMP

A full-precision timestamp including date and time.

PaymentsCustomerProductsPurchasedConditions

Fields you can use inside `customer.products_purchased MATCHES (...)` when querying `FROM payments`.

date
Filter. Date the product(s) were purchased.
```
TIMESTAMP
```
id
Filter. Product IDs.
```
IDENTITY
```
quantity
Filter. Number purchased per order.
```
INTEGER
```
sum_quantity
Metric. Number purchased within the date range.
```
INTEGER
```

PaymentsCustomerShopifyEmailBouncedConditions

Fields you can use inside `customer.shopify_email.bounced MATCHES (...)` when querying `FROM payments`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was bounced.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was bounced.
```
INTEGER
```

PaymentsCustomerShopifyEmailClickedConditions

Fields you can use inside `customer.shopify_email.clicked MATCHES (...)` when querying `FROM payments`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was clicked.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was clicked.
```
INTEGER
```

PaymentsCustomerShopifyEmailDeliveredConditions

Fields you can use inside `customer.shopify_email.delivered MATCHES (...)` when querying `FROM payments`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was delivered.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was delivered.
```
INTEGER
```

PaymentsCustomerShopifyEmailMarkedAsSpamConditions

Fields you can use inside `customer.shopify_email.marked_as_spam MATCHES (...)` when querying `FROM payments`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was marked as spam.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was marked as spam.
```
INTEGER
```

PaymentsCustomerShopifyEmailOpenedConditions

Fields you can use inside `customer.shopify_email.opened MATCHES (...)` when querying `FROM payments`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was opened.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was opened.
```
INTEGER
```

PaymentsCustomerShopifyEmailUnsubscribedConditions

Fields you can use inside `customer.shopify_email.unsubscribed MATCHES (...)` when querying `FROM payments`.

activity_id
Filter. Marketing activity ID of the email campaign.
```
IDENTITY
```
date
Filter. Date on which the email was unsubscribed.
```
TIMESTAMP
```
count
Metric. Exact number of times an email was unsubscribed.
```
INTEGER
```

PaymentsCustomerStoreCreditAccountsConditions

Fields you can use inside `customer.store_credit_accounts MATCHES (...)` when querying `FROM payments`.

balance
Filter. Amount available to spend.
```
FLOAT
```
currency
Filter. Currency associated with the account.
```
STRING
```
last_credit_date
Filter. Date when credits were last added.
```
TIMESTAMP
```
next_expiry_date
Filter. Date when credits expire.
```
TIMESTAMP
```

FLOAT

A floating-point number used for measurements, rates, and other continuous numeric values.

PaymentsCustomerStorefrontEventCollectionViewedConditions

Fields you can use inside `customer.storefront_event.collection_viewed MATCHES (...)` when querying `FROM payments`.

date
Filter. Date collection was viewed.
```
TIMESTAMP
```
id
Filter. Collection ID.
```
IDENTITY
```
count
Metric. Times collection was viewed.
```
INTEGER
```

PaymentsCustomerStorefrontEventProductViewedConditions

Fields you can use inside `customer.storefront_event.product_viewed MATCHES (...)` when querying `FROM payments`.

date
Filter. Date product was viewed.
```
TIMESTAMP
```
id
Filter. Product ID.
```
IDENTITY
```
count
Metric. Times product was viewed.
```
INTEGER
```

PaymentsCustomerWithinDistanceConditions

Fields you can use inside `customer.within_distance MATCHES (...)` when querying `FROM payments`.

coordinates
Filter. Latitude and longitude of location. Required.
```
GEO_COORDINATE
```
distance_km
Filter. Maximum distance from location, in kilometers. Required: provide one of the `distance_km/mi` group.
```
FLOAT
```
distance_mi
Filter. Maximum distance from location, in miles. Required: provide one of the `distance_km/mi` group.
```
FLOAT
```

GEO_COORDINATE

A geographic coordinate value.

Anchor to Related schemasRelated schemas

payouts: Bank deposit data downstream of these transactions.
fees: Processing and FX costs charged on each transaction.
payment_attempts: Authorization rate and failure analysis upstream of successful transactions.
chargebacks: Disputed transactions when you want to size fraud losses.

Was this page helpful?