Choose a version:

payouts

The payouts schema reports on the deposits Shopify sends you, not the individual transactions inside them. Use it to build payout timelines and summarize payouts by currency.

Anchor to Use casesUse cases

Payout timeline: Group payout_amount by week or month to see how much Shopify deposited and when.
Currency view: Compare payout_amount with payout_amount_in_payout_currency by payout_currency to reconcile deposits across the currencies you settle in.

Examples

ShopifyQL

View in adminView query results in the ShopifyQL editor

FROM payouts

SHOW payout_amount, payout_amount_in_payout_currency

TIMESERIES month WITH CUMULATIVE_VALUES, TOTALS, PERCENT_CHANGE

DURING this_year

COMPARE TO previous_year

ORDER BY month ASC

VISUALIZE payout_amount TYPE line

Examples

Description
Compare cumulative `payout_amount` by month for the year to date against last year. This example uses [`CUMULATIVE_VALUES`](/docs/api/shopifyql/latest/syntax/with#cumulative-values) for a running total, with [`WITH PERCENT_CHANGE`](/docs/api/shopifyql/latest/syntax/with#percent-change-columns) and [`COMPARE TO previous_year`](/docs/api/shopifyql/latest/syntax/compare-to) adding the year-over-year change column.
ShopifyQL
```
FROM payouts
  SHOW payout_amount, payout_amount_in_payout_currency
  TIMESERIES month WITH CUMULATIVE_VALUES, TOTALS, PERCENT_CHANGE
  DURING this_year
  COMPARE TO previous_year
  ORDER BY month ASC
VISUALIZE payout_amount TYPE line
```
Description
Split last quarter's `payout_amount` by currency. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add the combined all-currency total to every row.
ShopifyQL
```
FROM payouts
  SHOW payout_amount, payout_amount_in_payout_currency
  GROUP BY payout_currency WITH TOTALS
  DURING last_quarter
  ORDER BY payout_amount DESC
VISUALIZE payout_amount TYPE donut
```
Description
Track your weekly payout totals last quarter in both your store currency and the currency each payout settled in. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add a last-quarter total beside the weekly rows.
ShopifyQL
```
FROM payouts
  SHOW payout_amount, payout_amount_in_payout_currency
  TIMESERIES week WITH TOTALS
  DURING last_quarter
  ORDER BY week ASC
VISUALIZE payout_amount TYPE line
```
Description
Track weekly `payout_amount` split by `payout_currency` across last quarter. This example uses [`GROUP_TOTALS`](/docs/api/shopifyql/latest/syntax/with#group-total-columns) to add a per-week total across currencies beside the per-currency bands.
ShopifyQL
```
FROM payouts
  SHOW payout_amount
  GROUP BY payout_currency WITH TOTALS, GROUP_TOTALS
  TIMESERIES week
  DURING last_quarter
  ORDER BY week ASC
VISUALIZE payout_amount TYPE stacked_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 payouts.

Anchor to payout_amount payout_amount: The value of payouts issued to your store, reported in your store's currency.
Anchor to payout_amount_in_payout_currency payout_amount_in_payout_currency: The value of payouts in the currency specified by payout_currency.

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

Anchor to day day: The day a payout was issued.
Anchor to day_of_week day_of_week: The day of the week a payout was issued, with values Monday through Sunday.
Anchor to hour hour: The hour a payout was issued.
Anchor to hour_of_day hour_of_day: The hour of the day when the payout was issued, with values 0 through 23.
Anchor to minute minute: The minute a payout was issued.
Anchor to month month: The month a payout was issued.
Anchor to month_of_year month_of_year: The month of the year when the payout was issued, with values 1 through 12.
Anchor to payout_currency payout_currency: Currency the payout was issued in
Anchor to quarter quarter: The quarter a payout was issued.
Anchor to second second: The second a payout was issued.
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 week week: The week a payout was issued.
Anchor to week_of_year week_of_year: The week of the year when the payout was issued, with values 1 through 53.
Anchor to year year: The year a payout was issued.
Anchor to shop_name shop_name: Name of your store

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.

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.

STRING

A sequence of characters representing text data.

QUARTER_TIMESTAMP

A date value representing the start of a fiscal quarter.

SECOND_TIMESTAMP

A timestamp truncated to second precision.

IDENTITY

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

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.

Anchor to Related schemasRelated schemas

payments: Transaction data upstream of these payouts.
fees: Processing and FX costs deducted from payouts.
chargebacks: Disputed transactions that reduce payout amounts.

Was this page helpful?