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

# Subscription Status



## OpenAPI

````yaml /api-reference/openapi/lite.json get /settings/subscription/status
openapi: 3.1.0
info:
  title: Depict Lite API
  version: 1.0.0
  description: >-
    REST API behind Depict Lite, the native Shopify app: onboarding,
    collections, boost & bury, dashboards, A/B testing and multi-store
    management. Endpoints are served under the /api/lite prefix and require an
    Auth0-issued bearer token.
servers:
  - url: /api/lite
security: []
paths:
  /settings/subscription/status:
    get:
      summary: Subscription Status
      operationId: subscription_status_settings_subscription_status_get
      parameters:
        - name: merchant_id
          in: query
          required: true
          schema:
            type: string
            title: Merchant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionStatus'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - Auth0: []
components:
  schemas:
    SubscriptionStatus:
      properties:
        num_active_collections:
          type: integer
          title: Num Active Collections
        max_active_collections:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Active Collections
        is_trial:
          type: boolean
          title: Is Trial
        trial_days_left:
          anyOf:
            - type: integer
            - type: 'null'
          title: Trial Days Left
        proj_sessions:
          anyOf:
            - type: integer
            - type: 'null'
          title: Proj Sessions
        num_sessions:
          type: integer
          title: Num Sessions
        max_sessions:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Sessions
        days_until_reset:
          type: integer
          title: Days Until Reset
        frozen:
          type: boolean
          title: Frozen
        installed_recently:
          type: boolean
          title: Installed Recently
        store_error:
          anyOf:
            - type: string
              enum:
                - invalid_api_key
                - payment_required
                - unknown
            - type: 'null'
          title: Store Error
        subscription:
          anyOf:
            - $ref: '#/components/schemas/ActiveSubscriptionDTO'
            - type: 'null'
      type: object
      required:
        - num_active_collections
        - max_active_collections
        - is_trial
        - trial_days_left
        - proj_sessions
        - num_sessions
        - max_sessions
        - days_until_reset
        - frozen
        - installed_recently
        - store_error
        - subscription
      title: SubscriptionStatus
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ActiveSubscriptionDTO:
      properties:
        id:
          type: integer
          title: Id
        name:
          $ref: '#/components/schemas/SubscriptionName'
        price:
          type: string
          title: Price
        interval:
          $ref: '#/components/schemas/AppPricingInterval'
        billing_on:
          anyOf:
            - type: string
            - type: 'null'
          title: Billing On
        trial_ends_on:
          anyOf:
            - type: string
            - type: 'null'
          title: Trial Ends On
        test:
          type: boolean
          title: Test
        status:
          type: string
          enum:
            - pending
            - accepted
            - active
            - declined
            - expired
            - frozen
            - cancelled
          title: Status
      type: object
      required:
        - id
        - name
        - price
        - interval
        - billing_on
        - trial_ends_on
        - test
        - status
      title: ActiveSubscriptionDTO
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SubscriptionName:
      type: string
      enum:
        - Basic
        - Essential
        - Pro
        - Custom
      title: SubscriptionName
    AppPricingInterval:
      type: string
      enum:
        - ANNUAL
        - EVERY_30_DAYS
      title: AppPricingInterval
  securitySchemes:
    Auth0:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            openid: OpenID Connect
            profile: User profile
            email: User email
          authorizationUrl: https://depict.eu.auth0.com/oauth/authorize
          tokenUrl: https://depict.eu.auth0.com/oauth/token
      x-tokenName: id_token

````