---
title: "The store behind the key"
method: GET
path: "/v1/store"
tags: ["store"]
---

# The store behind the key

`GET /v1/store`

## Request

- Base URL: `https://api.octaneai.com`
- URL: `https://api.octaneai.com/v1/store`
- Auth: HTTP bearer

## Response `200`

The store behind the key: who it is, its currency and timezone, its plan class, limits, the key's scopes and credit usage.

- StoreResponse
  - `name` string, nullable, required: The store's display name, as the dashboard names it
  - `shop_domain` string, nullable, required: The store's myshopify.com domain; null until its details sync
  - `currency` string, nullable, required: ISO code of the currency every money amount is in; null until the store's details sync
  - `timezone` string, nullable, required: IANA name of the store's own timezone, the one to read 'last week' in; null until its details sync. Analytics answer in the tz asked for, UTC by default
  - `plan_class` string, required: basic | plus | enterprise | paused; picks the limit table
  - `limits` Limits, required
    - `capacity` integer, required: Requests a key may burst before its bucket is full
    - `leak_per_second` number, required: Sustained requests per second per key
    - `bot_multiplier` integer, required: The store-wide bucket is this many times the key bucket
    - `analytics_soft_ttl_seconds` integer, required: Seconds before a cached analytics answer may refresh
    - `webhook_endpoints` integer, required: Maximum webhook endpoints for the store
    - `webhook_sends_per_second` integer, required: Sustained webhook sends per second per endpoint
    - `export_page_pause_ms` integer, required: Milliseconds an export job rests between pages of the store's data
  - `scopes` string[], required: The scopes this key carries
  - `credits` StoreCredits, required
    - `limit` union, required: Monthly credit cap; 'unlimited' when plan is unmetered
      - integer
      - 'unlimited'
    - `used` integer, required: Credits consumed in the current billing cycle
    - `overages_enabled` boolean, required: Whether overage charges are permitted past the limit
    - `threshold` integer, nullable, required: Hard overage cap (null when overages_enabled is false)

## Other responses

- `401`: The key is missing, malformed, revoked or expired.
- `403`: The store's plan has no API access, or the key lacks the scope.
- `429`: The key's or the store's bucket is full; Retry-After says when to try again.

---

[API](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api.md) - [All operations](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api/revisions/dc2d1aa2b7c6?raw)