> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nmcrate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sales summary [+]

> Revenue, order count, average order value, and withheld tax for a period, with previous-period comparison.

Aggregated sales figures for a calendar period, alongside the equivalent previous period and percentage deltas, everything you need for a "this month vs last month" stat card.

<Info>
  **Tier:** Premium, requires a premium key **and** an active Branding+ subscription (checked on every request).
</Info>

## Request

```bash theme={null}
curl "https://nmcrate.com/api/public/v1/studio/sales/summary?period=thisMonth" \
  -H "x-api-key: nmk_studio_..."
```

### Query parameters

| Parameter | Type   | Default     | Description                                      |
| --------- | ------ | ----------- | ------------------------------------------------ |
| `period`  | string | `thisMonth` | `today`, `thisWeek`, `thisMonth`, or `thisYear`. |

## Response

```json theme={null}
{
  "period": "thisMonth",
  "range": {
    "start": "2026-07-01T00:00:00.000Z",
    "end": "2026-07-31T23:59:59.999Z"
  },
  "currency": "USD",
  "current": {
    "revenue": 1240.5,
    "orders": 96,
    "averageOrder": 12.92,
    "tax": 148.86
  },
  "previous": {
    "revenue": 980.0,
    "orders": 71,
    "averageOrder": 13.8,
    "tax": 117.6
  },
  "deltas": {
    "revenue": 26.6,
    "orders": 35.2,
    "averageOrder": -6.4
  }
}
```

| Field                  | Description                                                                                                                  |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `current` / `previous` | Totals for the requested period and the immediately preceding one (numbers, in USD dollars). Only **completed** sales count. |
| `current.revenue`      | Net revenue credited to the studio.                                                                                          |
| `current.tax`          | VAT withheld across the period's sales.                                                                                      |
| `deltas`               | Percentage change vs the previous period. `100` when the previous period was zero and the current isn't.                     |

## Errors

| HTTP | Code                    | When                                                             |
| ---- | ----------------------- | ---------------------------------------------------------------- |
| 403  | `PREMIUM_KEY_REQUIRED`  | The key is basic-tier.                                           |
| 403  | `SUBSCRIPTION_INACTIVE` | Premium key, but the Branding+ subscription is no longer active. |