# StoreInspect API

> Database-backed Shopify store and contact intelligence API. Store and contact data require a paid StoreInspect plan; existing keys can still access billing recovery endpoints after paid access lapses.

- Base URL: https://storeinspect.com/api/v1
- Authentication: Bearer API key
- OpenAPI schema: https://storeinspect.com/openapi.json
- Interactive documentation: https://storeinspect.com/docs
- MCP discovery: https://storeinspect.com/.well-known/mcp.json
- Pricing and limits: https://storeinspect.com/pricing.md

## Endpoints

## GET /api/v1/usage

Get usage

Returns API access state, request quota, search-row quota, and shared contact-credit usage for the authenticated account.

## GET /api/v1/billing/status

Get billing status

Returns the current plan, subscription state, billing cadence, contact credits, and whether paid API access is active. Existing valid API keys can use this endpoint while billing is inactive.

## POST /api/v1/billing/subscription-link

Create subscription link

Creates a short-lived Stripe-hosted paid Checkout, exact upgrade-confirmation, or billing-recovery link for the selected plan. API-created Checkout does not include a free trial. Creating the link never changes or charges the subscription; a human must open and confirm it in Stripe.

## POST /api/v1/billing/portal-link

Create billing portal link

Creates a short-lived Stripe-hosted link for payment details, invoices, cancellation, and billing recovery. Creating the link does not itself change billing.

## GET /api/v1/taxonomy

List taxonomy

Returns valid filter values and display labels for store search, contact search, and enrichment workflows.

## GET /api/v1/stores/{domain}

Get store

Enriches one known Shopify store domain from the StoreInspect database. Returning a store consumes the unique-store export allowance once per allowance period. V1 does not live-scan uncached domains.

## POST /api/v1/stores/search

Search stores

Searches Shopify stores by focused ICP filters with stable sorting, cursor pagination, broad-search guardrails, monthly search-row quotas, and a unique-store export allowance for returned stores.

## POST /api/v1/stores/enrich

Enrich stores

Batch enriches a small set of known Shopify store domains already present in the StoreInspect database. Returned stores consume the unique-store export allowance once per allowance period.

## POST /api/v1/contacts/search

Search contacts

Searches preview-safe contact records at Shopify stores using role, seniority, location, technology, and store ICP filters. Returned stores consume the unique-store export allowance once per allowance period.

## POST /api/v1/contacts/reveal

Reveal contacts

Reveals full contact identity and contact channels with shared contact credits, a unique-store export allowance for delivered store data, and optional idempotency protection.