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

> Retrieves a specific coupon by ID for the given configuration.



## OpenAPI

````yaml /openapi.json get /coupons/{provider_coupon_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:
  /coupons/{provider_coupon_id}:
    get:
      tags:
        - Coupons
      summary: Get Coupon
      description: Retrieves a specific coupon by ID for the given configuration.
      parameters:
        - in: path
          name: provider_coupon_id
          required: true
          schema:
            type: string
          description: Unique coupon identifier.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Coupon ID (the provider coupon id).
                      name:
                        type: string
                        description: Coupon name.
                      amount_off:
                        type:
                          - number
                          - 'null'
                        description: Fixed discount amount or null if percent-based.
                      currency:
                        type: string
                        description: Currency code (e.g., `"USD"`).
                      percent_off:
                        type:
                          - number
                          - 'null'
                        description: Percentage discount or null if amount-based.
                      applies_to_products:
                        type: array
                        items:
                          type: string
                        description: >-
                          The provider (the payment provider) product ids this
                          coupon applies to, listed as-is.
                      duration:
                        type: string
                        description: >-
                          How long the discount applies: `"forever"`, `"once"`,
                          or `"repeating"`.
                      duration_in_months:
                        type:
                          - number
                          - 'null'
                        description: >-
                          Number of months the discount applies when `duration`
                          is `"repeating"`; `null` otherwise.
                required:
                  - data
              example:
                data:
                  id: test_coupon_id
                  name: 10% Off
                  amount_off: null
                  currency: USD
                  percent_off: 10
                  applies_to_products:
                    - test_product_id
                  duration: repeating
                  duration_in_months: 3
        '400':
          description: 'ValidationError: Invalid `coupon_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: Coupon or config not found.'
        '500':
          description: Payment provider integration error.
      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.