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

> Retrieves a single price by ID.



## OpenAPI

````yaml /openapi.json get /prices/{price_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:
  /prices/{price_id}:
    get:
      tags:
        - Prices
      summary: Get Price
      description: Retrieves a single price by ID.
      parameters:
        - in: path
          name: price_id
          required: true
          schema:
            type: string
          description: >-
            Canonical price ID — the `id` field returned by List/Create/Update
            Price, or a product's `current_price_id`, not `provider_price_id`. A
            provider price 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 price ID, assigned by OpenLoop. Pass this to
                          GET /prices/{price_id} to fetch this price directly.
                      provider_price_id:
                        type: string
                        description: Upstream provider price ID.
                      config_id:
                        type: string
                        description: Configuration ID this price belongs to.
                      product_id:
                        type: string
                        description: Product ID this price belongs to.
                      nickname:
                        type:
                          - string
                          - 'null'
                        description: Optional price label; `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 (e.g. `"USD"`).
                      billing_interval:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Recurrence interval (e.g. `"month"`); `null` for
                          one-time prices.
                      billing_interval_count:
                        type:
                          - number
                          - 'null'
                        description: Recurrence multiplier; `null` for one-time prices.
                      amount_cents:
                        type: number
                        description: Price in cents.
                      status:
                        type: string
                        description: 'Archive status enum: `"ACTIVE"` or `"ARCHIVED"`.'
                      created_at:
                        type: string
                        description: ISO-8601 creation timestamp.
                      created_by_actor_id:
                        type:
                          - string
                          - 'null'
                        description: >-
                          ID of the actor that created the price; `null` for
                          system actors.
                      created_by_actor_type:
                        type: string
                        description: 'Actor type enum: `"USER"` or `"SYSTEM"`.'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        description: >-
                          ISO-8601 last-update timestamp; `null` when never
                          updated.
                      updated_by_actor_id:
                        type:
                          - string
                          - 'null'
                        description: >-
                          ID of the actor that last updated the price; `null`
                          when never updated or for system actors.
                      updated_by_actor_type:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Actor type enum (`"USER"` or `"SYSTEM"`); `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.
                required:
                  - data
              example:
                data:
                  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 `price_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: Price 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.