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

# List a patient's current care plan benefit redemptions

> Returns benefit redemptions for a clinic patient's current care plan enrollment: the core plan, its add-ons, and its service packages.

A care plan benefit is an allowance on that enrollment: a pool of points, unlimited included services, or a percent discount. A redemption is one use of that benefit, either on an invoice line or imported without one. Each benefit shows how much has been used, how much remains, and the uses that still count.



## OpenAPI

````yaml get /ext/v2/patient-care-plans/benefit-redemptions/
openapi: 3.1.0
info:
  description: ''
  title: NinjaAPI
  version: 2.0.0
servers:
  - url: https://connect.vetcove.com/
security: []
paths:
  /ext/v2/patient-care-plans/benefit-redemptions/:
    get:
      tags:
        - Care Plans
      summary: List a patient's current care plan benefit redemptions
      description: >-
        Returns benefit redemptions for a clinic patient's current care plan
        enrollment: the core plan, its add-ons, and its service packages.


        A care plan benefit is an allowance on that enrollment: a pool of
        points, unlimited included services, or a percent discount. A redemption
        is one use of that benefit, either on an invoice line or imported
        without one. Each benefit shows how much has been used, how much
        remains, and the uses that still count.
      operationId: patient_care_plan_benefit_redemptions_list
      parameters:
        - description: The ID of the patient to fetch the current care plan for
          in: query
          name: clinic_patient_id
          required: true
          schema:
            description: The ID of the patient to fetch the current care plan for
            title: Clinic Patient Id
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ExternalPatientCarePlanWithRedemptionsSchemaList
          description: OK
      security:
        - ExternalAPIAuth: []
components:
  schemas:
    ExternalPatientCarePlanWithRedemptionsSchemaList:
      properties:
        data:
          description: A single page of data contained within this list.
          items:
            $ref: '#/components/schemas/ExternalPatientCarePlanWithRedemptionsSchema'
          title: Data
          type: array
        has_more:
          default: false
          description: Whether there are more pages or data in this list.
          title: Has More
          type: boolean
        next_page:
          description: A URL linking to the next page of this list.
          title: Next Page
          type: string
        type:
          default: list
          description: Type of this object. Always `list`.
          title: Type
          type: string
      required:
        - data
        - next_page
      title: ExternalPatientCarePlanWithRedemptionsSchemaList
      type: object
    ExternalPatientCarePlanWithRedemptionsSchema:
      properties:
        benefits:
          description: Benefits on this enrollment, in benefit id order.
          items:
            $ref: >-
              #/components/schemas/ExternalPatientCareBenefitWithRedemptionsSchema
          title: Benefits
          type: array
        care_plan_id:
          description: The ID of the care plan template this enrollment is based on.
          title: Care Plan Id
          type: integer
        care_plan_kind:
          $ref: '#/components/schemas/CarePlanKind'
          description: >-
            Whether this enrollment is a core plan, an add-on, or a service
            package.
        care_plan_name:
          description: The name of the care plan template.
          title: Care Plan Name
          type: string
        id:
          description: The unique identifier for the patient care plan enrollment.
          title: Id
          type: integer
      required:
        - id
        - care_plan_id
        - care_plan_name
        - care_plan_kind
        - benefits
      title: ExternalPatientCarePlanWithRedemptionsSchema
      type: object
    ExternalPatientCareBenefitWithRedemptionsSchema:
      properties:
        care_benefit_id:
          description: >-
            The ID of the care benefit template this patient benefit is based
            on.
          title: Care Benefit Id
          type: integer
        discount_percent:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The discount fraction for a discount benefit, from 0 to 1. Null when
            the benefit is not a percent discount.
          title: Discount Percent
        id:
          description: The unique identifier for the patient's benefit.
          title: Id
          type: integer
        kind:
          anyOf:
            - $ref: '#/components/schemas/CareBenefitKind'
            - const: ''
              type: string
          description: >-
            How the benefit is consumed: a point pool, unlimited services, or a
            percent discount.
          title: Kind
        name:
          description: The name of the care benefit.
          title: Name
          type: string
        points_remaining:
          anyOf:
            - type: integer
            - type: 'null'
          description: Points still available. Null when the benefit is not point-based.
          title: Points Remaining
        points_used:
          anyOf:
            - type: integer
            - type: 'null'
          description: Points already consumed. Null when the benefit is not point-based.
          title: Points Used
        redemptions:
          description: >-
            Redemptions that count toward this benefit, oldest first. Imported
            redemptions have no invoice line. Redemptions whose invoice line was
            fully not rendered are omitted. For an unlimited benefit, usage is
            the sum of rendered quantities, and an imported redemption counts as
            1.
          items:
            $ref: '#/components/schemas/ExternalPatientCareBenefitRedemptionSchema'
          title: Redemptions
          type: array
        total_points:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The point pool for a point benefit. Null when the benefit is not
            point-based.
          title: Total Points
        total_savings:
          description: The total discount counted for this benefit, in cents.
          title: Total Savings
          type: integer
      required:
        - id
        - name
        - care_benefit_id
        - kind
        - total_points
        - points_used
        - points_remaining
        - discount_percent
        - total_savings
        - redemptions
      title: ExternalPatientCareBenefitWithRedemptionsSchema
      type: object
    CarePlanKind:
      enum:
        - CORE
        - ADD_ON
        - SERVICE_PACKAGE
      title: CarePlanKind
      type: string
    CareBenefitKind:
      enum:
        - UNLIMITED
        - POINTS
        - DISCOUNT
      title: CareBenefitKind
      type: string
    ExternalPatientCareBenefitRedemptionSchema:
      properties:
        amount_discounted:
          description: >-
            Discount counted for this redemption, in cents. Amounts restored
            when a line was not rendered are already removed.
          title: Amount Discounted
          type: integer
        created:
          description: When the redemption was recorded.
          format: date-time
          title: Created
          type: string
        id:
          description: The unique identifier for the redemption.
          title: Id
          type: integer
        invoice_item:
          anyOf:
            - $ref: >-
                #/components/schemas/ExternalPatientCareBenefitRedemptionInvoiceItemSchema
            - type: 'null'
          description: >-
            The invoice line this redemption applied to. Null when the
            redemption was imported without an invoice line.
        points_redeemed:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Points counted for this redemption. Restored points are already
            removed. Null when the redemption is not point-based.
          title: Points Redeemed
      required:
        - id
        - created
        - points_redeemed
        - amount_discounted
        - invoice_item
      title: ExternalPatientCareBenefitRedemptionSchema
      type: object
    ExternalPatientCareBenefitRedemptionInvoiceItemSchema:
      properties:
        id:
          description: The unique identifier for the invoice line.
          title: Id
          type: integer
        line_display:
          description: The description shown for the invoice line.
          title: Line Display
          type: string
        quantity_rendered:
          anyOf:
            - type: number
            - type: string
          description: >-
            The quantity of the invoice line that was rendered. Quantity marked
            as not rendered is excluded.
          title: Quantity Rendered
      required:
        - id
        - line_display
        - quantity_rendered
      title: ExternalPatientCareBenefitRedemptionInvoiceItemSchema
      type: object
  securitySchemes:
    ExternalAPIAuth:
      scheme: bearer
      type: http

````