---
title: "Get a BillingCopay by id"
method: GET
path: "/billingCopays/{billingCopayId}"
tags: ["billingCopays"]
---

# Get a BillingCopay by id

`GET /billingCopays/{billingCopayId}`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/billingCopays/{billingCopayId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/billingCopays/:billingCopayId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `billingCopayId` string, required

## Response `200`

BillingCopay

- BillingCopaysResponse
  - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
  - `createdBy` string: The ID of the user who created this object.
  - `updatedBy` string: The ID of the user who updated this object.
  - `deletedBy` string: The ID of the user who deleted this object.
  - `createdAt` string, date-time: The date/time when this object was created.
  - `updatedAt` string, date-time: The date/time when this object was updated.
  - `deletedAt` string, date-time: The date/time when this object was deleted.
  - `_id` string: Luma's internal ID of an object.
  - `user` string: The ID of the root account user.
  - `source` 'system' | 'ehr' | 'manual'
  - `type` 'balance' | 'behavioral' | 'copay' | 'custom' | 'dental' | 'medical'
  - `model` 'appointment' | 'patient' | 'offer'
  - `calculation` string
  - `name` string
  - `amount` number
  - `currency` string
  - `visible` boolean
  - `appointment` string
  - `patient` string
  - `preAuthorization` boolean

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)