Choose a version:

store_credit_summaries

The store_credit_summaries schema captures store credit balances as point-in-time snapshots. It's the summary view that pairs with the transaction-level store credit data, and it's best for tracking balances over a period.

Anchor to Use casesUse cases

Period balances: Show starting_store_credit_balance and ending_store_credit_balance by day or month to track outstanding store credit liability over time.
Movement by currency: Group store_credit_balance_net_change by store_credit_currency to see which currencies drive changes in credit balance.

Examples

ShopifyQL

View in adminView query results in the ShopifyQL editor

FROM store_credit_summaries

SHOW ending_store_credit_balance

GROUP BY store_credit_currency WITH TOTALS

SINCE -7d UNTIL today

ORDER BY ending_store_credit_balance DESC

VISUALIZE ending_store_credit_balance TYPE donut

Examples

Description
Split the `ending_store_credit_balance` your store owes over the last seven days by currency. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add a total beside the per-currency breakdown.
ShopifyQL
```
FROM store_credit_summaries
  SHOW ending_store_credit_balance
  GROUP BY store_credit_currency WITH TOTALS
  SINCE -7d UNTIL today
  ORDER BY ending_store_credit_balance DESC
VISUALIZE ending_store_credit_balance TYPE donut
```
Description
Compare monthly `store_credit_balance_net_change` for the year to date against the same months last year. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add the year-to-date total net change beside the monthly bars.
ShopifyQL
```
FROM store_credit_summaries
  SHOW store_credit_balance_net_change
  TIMESERIES month WITH TOTALS
  DURING this_year
  COMPARE TO previous_year
  ORDER BY month ASC
VISUALIZE store_credit_balance_net_change TYPE bar
```
Description
Track monthly `starting_store_credit_balance` this year as a running total. This example uses [`CUMULATIVE_VALUES`](/docs/api/shopifyql/latest/syntax/with#cumulative-values) to carry each month's balance forward into a year-to-date running total.
ShopifyQL
```
FROM store_credit_summaries
  SHOW starting_store_credit_balance
  TIMESERIES month WITH CUMULATIVE_VALUES, TOTALS
  DURING this_year
  ORDER BY month ASC
VISUALIZE starting_store_credit_balance TYPE line
```
Description
Rank the 10 `store_credit_currency` values with the highest `starting_store_credit_balance` last month. This example pairs [`ORDER BY`](/docs/api/shopifyql/latest/syntax/order-by) `starting_store_credit_balance DESC` with `LIMIT 10`, so the sort decides which 10 currencies survive the cut.
ShopifyQL
```
FROM store_credit_summaries
  SHOW starting_store_credit_balance
  GROUP BY store_credit_currency WITH TOTALS
  DURING last_month
  ORDER BY starting_store_credit_balance DESC
  LIMIT 10
VISUALIZE starting_store_credit_balance TYPE horizontal_bar
```

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

Anchor to ending_store_credit_balance ending_store_credit_balance: The store credit balance at the end of the selected period, in the currency shown by store_credit_currency.
Anchor to starting_store_credit_balance starting_store_credit_balance: The store credit balance at the beginning of the selected period, in the currency shown by store_credit_currency.
Anchor to store_credit_balance_net_change store_credit_balance_net_change: The store credit balance change for the selected period, in the currency shown by store_credit_currency.

Store credit balance net change = ending store credit balance – starting store credit balance

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

Anchor to day day: Day (timestamp) the data was recorded
Anchor to month month: Month (timestamp) the data was recorded
Anchor to quarter quarter: Quarter (timestamp) the data was recorded
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 store_credit_currency store_credit_currency: Values are currency codes such as USD, EUR, GBP, and CAD.
Anchor to week week: Week (timestamp) the data was recorded
Anchor to year year: Year (timestamp) the data was recorded
Anchor to shop_name shop_name: Name of your store

DAY_TIMESTAMP

A date value truncated to day precision.

MONTH_TIMESTAMP

A date value representing the start of a month.

QUARTER_TIMESTAMP

A date value representing the start of a fiscal quarter.

IDENTITY

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

STRING

A sequence of characters representing text data.

WEEK_TIMESTAMP

A date value representing the start of a week.

YEAR_TIMESTAMP

A date value representing the start of a year.

Anchor to Related schemasRelated schemas

store_credit_transactions: Individual credit and debit events that drive these balances.
payments: Transaction data when you want to see how store credit is used at checkout.
payouts: Payout amounts alongside store-credit liability for a full cash picture.

Was this page helpful?