Event Hour

event_hour

string

The hour of the day the custom expense was incurred, according to a 24-hour clock. Based on the time zone of the shop at the moment the expense was incurred.

Example values: 07, 16, 21

Event Date

event_date

date

The date the custom expense was incurred. Based on the time zone of the shop at the moment the expense was incurred.

Event Day

event_date.day

date

The day the event occurred. Derived from event_date.

Event Week

event_date.week

date

The Sunday of the week during which the event occurred. Derived from event_date.

Event Month

event_date.month

date

The month during which the event occurred. Derived from event_date.

Event Quarter

event_date.quarter

date

The first month of the quarter during which the event occurred. Derived from event_date.

Event Year

event_date.year

date

The year during which the event occurred. Derived from event_date.

Campaign ID

campaign_id

string

The name or ID of the campaign the custom expense is associated with.

Note: This may match an existing campaign ID in an integrated ad platform. Edit in Cost Settings > Custom Expenses.

Example values: 23852438666180053, 531011533, 20620285829

Custom Expense Category

category

string

The category of the custom expense. Edit in Cost Settings > Custom Expenses.

Example values: Ad Spend, Cashback Booked, Returns Estimate

Channel

channel

string

The channel or platform related to the custom expense.

Note: This may match an existing integrated ad channel. Edit in Cost Settings > Custom Expenses.

Example values: facebook, social, microsoft

Is Ad Spend

is_ad_spend

boolean

True if the custom expense is considered an advertising expenditure. Edit in Cost Settings > Custom Expenses.

Is Recurring

is_recurring

boolean

True if the custom expense is recurring. Edit in Cost Settings > Custom Expenses.

Note: Only relevant for fixed expenses. NULL for variable expenses.

Variable Expense Base Metric

metric

string

The metric upon which the variable custom expense will be based. Edit in Cost Settings > Custom Expenses.

Note: Only relevant for variable expenses. NULL for fixed expenses.

Example values: Blended Ads, COGS, Orders

Variable Expense Rate

rate

string

The rate applied to the base metric to calculate the custom expense. Edit in Cost Settings > Custom Expenses, in the percent field.

Note: Only relevant for variable expenses. NULL for fixed expenses.

Example value: 0.02

Custom Expense Title

title

string

The title of the custom expense. Edit in Cost Settings > Custom Expenses.

Example values: Podcast, Influencer

Custom Expense Amount

amount

numeric

The amount of the expense. By default shown in the shop's currency.

Note: For fixed expenses, the amount is set directly by the seller; for variable expenses, the amount is calculated based on the base metric and rate set by the seller, combined with shop prices from the sales, ad, or email/SMS platform (e.g. Shopify, Facebook, Klaviyo). Edit in Cost Settings > Custom Expenses.