earnings_by_month
Calculates your net, gross, and Shopify fees per month by currency and earning event type, plus upcoming settlements, from the app's full event history.
Instructions
What you actually earned per month: net, gross, and Shopify fee per currency, split by earning event type (recurring, usage, one-time, refund, credit, adjustment), plus upcoming settlements by date. Computed from the app's full event history, which the server downloads once and caches for 15 minutes.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "earnings_by_month"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appId | No | App ID: the number or a gid:// ID. Optional when SHOPIFY_PARTNER_APP_IDS names exactly one app | |
| months | No | How many calendar months, ending with the current one |