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

# Get Product By Id

> Retrieves a single product by ID.



## OpenAPI

````yaml /openapi.json get /products/{product_id}
openapi: 3.1.0
info:
  title: OpenLoop API
  version: 0.1.0
  description: >-
    Unified reference for the OpenLoop Patient (clinical) and Payments & Revenue
    APIs.
servers:
  - url: https://api.openloophealth.com/v0.1
    description: Production partner edge
  - url: https://api-staging.openloophealth.com/v0.1
    description: Staging partner edge (sandbox credentials)
security: []
paths:
  /products/{product_id}:
    get:
      tags:
        - Products
      summary: Get Product By Id
      description: Retrieves a single product by ID.
      parameters:
        - in: path
          name: product_id
          required: true
          schema:
            type: string
          description: >-
            Canonical product ID — the `id` field returned by List/Create/Update
            Product, not `provider_product_id`. A provider product ID is never
            accepted here and returns a `404`.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          Canonical product ID, assigned by OpenLoop. Pass this
                          to GET /products/{product_id} to fetch this product
                          directly.
                      provider_product_id:
                        type: string
                        description: Provider (the payment provider) product ID.
                      config_id:
                        type: string
                        description: Config the product belongs to.
                      item_type:
                        type: string
                        description: '`''PRODUCT''` or `''BUNDLE''`.'
                      name:
                        type: string
                        description: Product name.
                      description:
                        type:
                          - string
                          - 'null'
                        description: Long description; `null` when unset.
                      program_id:
                        type:
                          - string
                          - 'null'
                        description: Program ID; `null` for bundles.
                      program_code:
                        type:
                          - string
                          - 'null'
                        description: Program code; `null` for bundles.
                      current_price_id:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Canonical ID of this product's current price, or
                          `null` when none. Pass this to GET /prices/{price_id}
                          to fetch that price directly.
                      charge_category:
                        type:
                          - string
                          - 'null'
                        description: Charge category; `null` when unset.
                      medications:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Medication ID.
                            name:
                              type: string
                              description: Medication name.
                            abbreviation:
                              type: string
                              description: Medication abbreviation.
                        description: >-
                          Associated medications. Fields documented in the
                          sub-table below.
                      medication_product_id:
                        type:
                          - string
                          - 'null'
                        description: Related medication product ID; `null` when unset.
                      insurance_eligible:
                        type:
                          - boolean
                          - 'null'
                        description: >-
                          Whether the product is insurance-eligible; `null` when
                          unset.
                      thumbnail_url:
                        type:
                          - string
                          - 'null'
                        description: Private thumbnail URL; `null` when unset.
                      thumbnail_public_url:
                        type:
                          - string
                          - 'null'
                        description: Public thumbnail URL; `null` when unset.
                      product_ids:
                        type:
                          - array
                          - 'null'
                        items:
                          type: string
                        description: Bundled product IDs; `null` for non-bundles.
                      use_default_price:
                        type:
                          - boolean
                          - 'null'
                        description: Bundle pricing strategy; `null` for non-bundles.
                      status:
                        type: string
                        description: '`''ACTIVE''` or `''ARCHIVED''`.'
                      created_at:
                        type: string
                        description: ISO-8601 UTC creation timestamp.
                      created_by_actor_id:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Actor ID that created the product; `null` when
                          unknown.
                      created_by_actor_type:
                        type: string
                        description: '`''USER''` or `''SYSTEM''`.'
                      updated_at:
                        type: string
                        description: ISO-8601 UTC last-update timestamp.
                      updated_by_actor_id:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Actor ID that last updated the product; `null` when
                          unknown.
                      updated_by_actor_type:
                        type:
                          - string
                          - 'null'
                        description: '`''USER''`/`''SYSTEM''`, or `null` when never updated.'
                      prices:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Internal price ID.
                            provider_price_id:
                              type: string
                              description: Provider (the payment provider) price ID.
                            config_id:
                              type: string
                              description: Config the price belongs to.
                            product_id:
                              type: string
                              description: Product the price belongs to.
                            nickname:
                              type:
                                - string
                                - 'null'
                              description: Price nickname; `null` when unset.
                            funnel_id:
                              type:
                                - string
                                - 'null'
                              description: Associated funnel ID; `null` when unset.
                            entitlements:
                              type:
                                - number
                                - 'null'
                              description: >-
                                Non-negative integer; how many shipments one
                                payment period covers. `null` when unset.
                            currency:
                              type: string
                              description: ISO currency code.
                            billing_interval:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Billing period (e.g. `'month'`); `null` for
                                one-time.
                            billing_interval_count:
                              type:
                                - number
                                - 'null'
                              description: >-
                                Multiplier for the interval; `null` for
                                one-time.
                            amount_cents:
                              type: number
                              description: Price in cents.
                            status:
                              type: string
                              description: '`''ACTIVE''` or `''ARCHIVED''`.'
                            created_at:
                              type: string
                              description: ISO-8601 UTC creation timestamp.
                            created_by_actor_id:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Actor ID that created the price; `null` when
                                unknown.
                            created_by_actor_type:
                              type: string
                              description: '`''USER''` or `''SYSTEM''`.'
                            updated_at:
                              type:
                                - string
                                - 'null'
                              description: >-
                                ISO-8601 UTC last-update timestamp; `null` when
                                never updated.
                            updated_by_actor_id:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Actor ID that last updated the price; `null`
                                when unknown.
                            updated_by_actor_type:
                              type:
                                - string
                                - 'null'
                              description: >-
                                `'USER'`/`'SYSTEM'`, or `null` when never
                                updated.
                            metadata:
                              type: object
                              additionalProperties:
                                type: string
                              description: >-
                                the payment provider metadata map — always
                                present, `{}` when empty (never omitted or
                                `null`). Refreshed from the payment provider
                                every hour, so a change made directly there can
                                take up to an hour to appear.
                        description: >-
                          Prices attached to the product. Fields documented in
                          the sub-table below.
                      sku_suffixes:
                        type:
                          - array
                          - 'null'
                        items:
                          type: string
                        description: SKU suffix variants; `null` when unset.
                      entitlements:
                        type:
                          - number
                          - 'null'
                        description: >-
                          Shipments covered by one payment period; `null` when
                          unset.
                      funnel_id:
                        type:
                          - string
                          - 'null'
                        description: Associated funnel ID; `null` when unset.
                      metadata:
                        type: object
                        additionalProperties:
                          type: string
                        description: >-
                          the payment provider metadata map — always present,
                          `{}` when empty (never omitted or `null`).
                required:
                  - data
              example:
                data:
                  id: 01M0WJ8KBZ3TV8J1VHPHPQRY95
                  provider_product_id: test_provider_product_id
                  config_id: test_config_id
                  item_type: PRODUCT
                  name: MWL Monthly Subscription
                  description: Compounded GLP-1 (Semaglutide)
                  program_id: test_program_id
                  program_code: MWL
                  current_price_id: 01M0WJ8KXS1QGWPJGMCS5C8TZJ
                  charge_category: MEDICATION
                  medications: []
                  medication_product_id: null
                  insurance_eligible: false
                  thumbnail_url: null
                  thumbnail_public_url: null
                  product_ids: null
                  use_default_price: null
                  status: ACTIVE
                  created_at: '2026-05-25T12:00:00Z'
                  created_by_actor_id: null
                  created_by_actor_type: SYSTEM
                  updated_at: '2026-05-25T12:00:00Z'
                  updated_by_actor_id: null
                  updated_by_actor_type: null
                  sku_suffixes: null
                  entitlements: null
                  funnel_id: null
                  metadata: {}
                  prices:
                    - id: 01M0WJ8KXS1QGWPJGMCS5C8TZJ
                      provider_price_id: test_provider_price_id
                      config_id: test_config_id
                      product_id: 01M0WJ8KBZ3TV8J1VHPHPQRY95
                      nickname: null
                      funnel_id: null
                      entitlements: null
                      currency: USD
                      billing_interval: month
                      billing_interval_count: 1
                      amount_cents: 9999
                      status: ACTIVE
                      created_at: '2026-05-25T12:00:00Z'
                      created_by_actor_id: null
                      created_by_actor_type: SYSTEM
                      updated_at: null
                      updated_by_actor_id: null
                      updated_by_actor_type: null
                      metadata: {}
        '400':
          description: 'ValidationError: Missing `product_id`.'
        '401':
          description: Missing or invalid bearer token.
        '403':
          description: >-
            No configuration exists for your account, or provider access has
            been disabled for it.
        '404':
          description: 'NotFoundError: Product not found in database or upstream.'
        '429':
          description: >-
            DynamoDB read throttled. Response carries `Retry-After: 5`
            (seconds).
        '500':
          description: Upstream fetch fails.
      security:
        - serviceToken: []
        - userToken: []
components:
  securitySchemes:
    serviceToken:
      type: oauth2
      description: >-
        Service (M2M) access token issued by POST /auth/token using the
        client_credentials grant. Required scopes, where known, are listed on
        each operation below.
      flows:
        clientCredentials:
          tokenUrl: https://api.openloophealth.com/v0.1/auth/token
          scopes: {}
    userToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User access token issued by POST /auth/token via the verification-code
        grant (after Verify a one-time code) or the refresh_token grant.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.