Skip to main content

Rentals via API

Create, view, start, stop, and update patient rental programs, which bill recurring rental charges for equipment like oxygen concentrators, CPAP machines, and hospital beds.

How Rental Programs Work

A rental program bills a HCPCS service to a patient's insurance (or the patient) on a recurring cycle, creating an invoice each rental period.

Status

Meaning

New

Created but not yet billing

Active

Billing on its cycle

Hold

Paused. See HoldReason: MultiplePricingOptions, NoPriceOptionsAvailable, or BillToPayerDeleted.

Stopped

Stopped before completing

Completed

All rental periods billed

The billing cycle (Cycle) is Daily, Weekly, or Monthly, based on the price option.

💡 Rental programs can also be started from an invoice service line by setting EnableRental and RentSettings.


Before You Start: Lookups

What you need

Endpoint

Price options (rental)

GET /v1/price-options

Billing provider

GET /v1/billing-providers

Service location

GET /v1/organization/locations

Patient insurance to bill

GET /v1/patients/{patientId}/insurances

Place of service codes

GET /v1/place-of-service

Product

GET /v1/products


Create a Rental Program

POST /v1/patients/{patientId}/rentals

Fields

Field

Required

Notes

Hcpcs

✅

e.g. E1390

Service

✅

Service description

Quantity

✅

DateOfService.From / .To

✅

YYYY-MM-DD

PlaceOfService

✅

e.g. 12 (Home)

PriceOptionId

✅

A rental price option

BillingProviderId

✅

ServiceLocationId

✅

Status

✅

New or Active only

BillToInsuranceId

Patient insurance ID to bill

ProductId

OrderId

The related order

RentalPeriod

Starting rental period number

PriorAuthorizationNumber

ModifierOverride

Override the price option's modifiers (see below)

ScheduledStop

Stop the program automatically: Date and Reason (both required if sent)

AdditionalInfo

Free text

Modifier Override

Field

Notes

Type

Replace (default) or Append

Modifiers.Level1

Required. Also Level2, Level3, Level4.

Example

POST /v1/patients/10000105/rentals
{
"Hcpcs": "E1390",
"Service": "Oxygen concentrator",
"Quantity": 1,
"DateOfService": { "From": "2026-11-10", "To": "2026-12-09" },
"PlaceOfService": "12",
"PriceOptionId": "PO73ae8d0060ca90fa4e04893c801275a3",
"BillingProviderId": "BP28538d00acea414bbc940e0fda497f92",
"ServiceLocationId": "OL3b309d00aceae09bd4544bef2658410e",
"BillToInsuranceId": "PIf5b1af006f4bdafa8b540aca26806e0d",
"ProductId": "A05MW34SX96ZF71QT28K",
"OrderId": "SO05adce00ef4b092b90f42f97b2ec3e36",
"Status": "New",
"ModifierOverride": {
"Type": "Append",
"Modifiers": { "Level1": "KX" }
}
}

Response: 201 Created


Get a Patient's Rental Programs

GET /v2/patients/{patientId}/rentals

GET /v1/patients/{patientId}/rentals is deprecated. The V2 endpoint takes the same filters.

Filter

Notes

statuses

New, Active, Hold, Stopped, Completed

hcpcsCode

orderIds

dateFrom / dateTo

includeArchived

pageIndex / pageSize

Paging

{
"Items": [
{
"Id": "RPce93de00ef4bcb185254706e01a64bca",
"Status": "Active",
"Cycle": "Monthly",
"Hcpcs": "E1390",
"Service": "Oxygen concentrator",
"Quantity": 1,
"RentalPeriod": 3,
"DateOfService": { "From": "2026-11-10T00:00:00", "To": "2026-12-09T00:00:00" },
"PlaceOfService": "12",
"OrderId": "SO05adce00ef4b092b90f42f97b2ec3e36",
"LastInvoiceId": "IN30a3de00ef4b365bb714b69708cadffd",
"BillToInsuranceId": "PIf5b1af006f4bdafa8b540aca26806e0d",
"BillingProvider": { "Id": "BP28538d00acea414bbc940e0fda497f92", "Npi": "1234567890", "Name": "Example Medical Supply" },
"Product": { "Id": "A05MW34SX96ZF71QT28K", "Name": "Oxygen Concentrator 5L" }
}
]
}

Rental program IDs start with RP, the same prefix as referring provider IDs. They're different record types, so don't mix them up.

Get one rental program: GET /v1/patients/{patientId}/rentals/{id}. Also returns StopReason, ScheduledStop, and PriorAuthorizationNumber.


Start a Rental Program

PUT /v1/patients/{patientId}/rentals/{id}/start

Starts billing for a New program. No request body.

Response: 200 OK


Stop a Rental Program

PUT /v1/patients/{patientId}/rentals/{id}/stop

Field

Required

Notes

Reason

✅

Why the program is being stopped

StopDate

YYYY-MM-DD. Leave it out to stop today.

{
"Reason": "Equipment returned",
"StopDate": "2026-12-01"
}

Response: 200 OK

💡 To schedule a stop when you create or update the program, use ScheduledStop instead.


Update a Rental Program

PUT /v1/patients/{patientId}/rentals/{id}

Uses the same fields as creating a program, except Status. Use start and stop to change the status. Hcpcs, Service, Quantity, DateOfService, PlaceOfService, PriceOptionId, BillingProviderId, and ServiceLocationId are required.

Response: 200 OK


Common Errors

Code

Meaning

400

Invalid request, e.g. a missing required field, a Status other than New or Active on create, or a non-rental price option

401

Token missing, expired, or invalid

403

You don't have permission to access this resource

404

Patient or rental program not found

429

Too many requests


Related articles

Did this answer your question?