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

# 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.



## OpenAPI

````yaml /openapi.json get /billing/status
openapi: 3.1.0
info:
  title: StoreInspect API
  version: 1.0.0
  description: >-
    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.
servers:
  - url: https://storeinspect.com/api/v1
security: []
tags:
  - name: usage
    x-displayName: Usage
    x-group: Usage
    description: >-
      API access state, request quotas, search-row quota, and shared
      contact-credit usage.
  - name: billing
    x-displayName: Billing
    x-group: Billing
    description: >-
      Read subscription state and create short-lived Stripe-hosted subscription
      or management links.
  - name: taxonomy
    x-displayName: Taxonomy
    x-group: Taxonomy
    description: >-
      Filter values, labels, and metadata used by store and contact search
      requests.
  - name: stores
    x-displayName: Stores
    x-group: Stores
    description: >-
      Store lookup, store search, and batch domain enrichment for Shopify
      accounts.
  - name: contacts
    x-displayName: Contacts
    x-group: Contacts
    description: Contact preview search and credit-based contact reveal workflows.
paths:
  /billing/status:
    get:
      tags:
        - billing
      summary: Get billing status
      description: >-
        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.
      operationId: getBillingStatus
      responses:
        '200':
          description: Current billing state for the API key owner.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingStatusResponse'
        '401':
          description: Missing, invalid, revoked, or suspended API key.
        '403':
          description: The API key does not have billing:read.
        '429':
          description: Too many billing status requests.
      security:
        - bearerAuth: []
components:
  schemas:
    BillingStatusResponse:
      type: object
      properties:
        object:
          type: string
          const: billing_status
        plan:
          type: object
          properties:
            slug:
              type: string
              enum:
                - free
                - pro
                - business
                - enterprise
            name:
              type: string
            status:
              type: string
            billing:
              type:
                - string
                - 'null'
              enum:
                - monthly
                - annual
                - null
            trial:
              type: object
              properties:
                active:
                  type: boolean
                ends_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
              required:
                - active
                - ends_at
            cancel_at_period_end:
              type: boolean
            current_period_end:
              type:
                - string
                - 'null'
              format: date-time
          required:
            - slug
            - name
            - status
            - billing
            - trial
            - cancel_at_period_end
            - current_period_end
        api_access:
          type: object
          properties:
            enabled:
              type: boolean
          required:
            - enabled
        contact_credits:
          type: object
          properties:
            total:
              type: integer
              minimum: 0
            used:
              type: integer
              minimum: 0
            remaining:
              type: integer
              minimum: 0
          required:
            - total
            - used
            - remaining
        has_billing_account:
          type: boolean
        actions:
          type: object
          properties:
            can_create_subscription_link:
              type: boolean
            can_manage_billing:
              type: boolean
          required:
            - can_create_subscription_link
            - can_manage_billing
        request_id:
          type: string
      required:
        - object
        - plan
        - api_access
        - contact_credits
        - has_billing_account
        - actions
        - request_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: StoreInspect API key

````