Discount Plan Subs

Patient subscriptions to a discount plan. Get by PatNum, create (subscribe patient), update, or delete. Per OpenDental API DiscountPlanSubs.

DiscountPlanSubs — Gets or manages the DiscountPlanSub for a patient subscribed to a discount plan. See Discount Plan for plan definitions. Schema: DiscountPlanSub Database Schema.

PatNum *

Enter a PatNum and click "Get Subscription" to view.

DiscountSubNum	DiscountPlanNum	PatNum	DateEffective	DateTerm	SubNote	Actions

Subscribe Patient to Discount Plan

DiscountPlanNum and PatNum required. Dates in yyyy-MM-dd; default 0001-01-01 (DateEffective = start of year, DateTerm = no end).

DiscountPlanNum *

PatNum *

DateEffective

Optional. yyyy-MM-dd. Default 0001-01-01 (start of current year).

DateTerm

Optional. yyyy-MM-dd. Default 0001-01-01 (no end date).

SubNote

Result:

Update Discount Plan Subscription

PatNum is required in the body. Updating SubNote overwrites the existing note.

DiscountSubNum * (in URL)

PatNum *

The PatNum attached to this DiscountPlanSub.

DateEffective

DateTerm

SubNote

Result:

Delete Discount Plan Subscription

Permanently removes the patient's subscription. DiscountSubNum is required in the URL.

DiscountSubNum *

Result:

DiscountPlanSubs GET

GET /discountplansubs?PatNum={PatNum}. PatNum required. Returns the DiscountPlanSub for that patient (single object). 404 if not found or not subscribed. Version 21.3.

Example Response (200 OK):

{"DiscountSubNum": 32, "DiscountPlanNum": 8, "PatNum": 56, "DateEffective": "2021-01-01", "DateTerm": "2022-01-01", "SubNote": ""}

All response fields:

DiscountSubNum — Primary key of the discountplansub table.
DiscountPlanNum — FK to the discount plan.
PatNum — Patient number.
DateEffective — Date when the plan starts impacting procedure fees (yyyy-MM-dd).
DateTerm — Date when the plan no longer impacts fees (yyyy-MM-dd).
SubNote — Subscriber note.

DiscountPlanSubs POST

Subscribes a patient to an existing DiscountPlan. Version 21.3.

Request body:

DiscountPlanNum — Required.
PatNum — Required.
DateEffective — Optional. yyyy-MM-dd. Default 0001-01-01 (start of current year).
DateTerm — Optional. yyyy-MM-dd. Default 0001-01-01 (no end date).
SubNote — Optional. Subscriber note.

Example:

{"DiscountPlanNum": 6, "PatNum": 67, "DateEffective": "2021-01-01", "DateTerm": "2022-01-01"}

DiscountPlanSubs PUT

Updates an existing DiscountPlanSub. DiscountSubNum in URL. Updating SubNote overwrites existing. Version 22.3.13.

URL:

PUT /discountplansubs/{DiscountSubNum}

Request body:

PatNum — Required. The PatNum attached to the DiscountPlanSub.
DateEffective — Optional. yyyy-MM-dd.
DateTerm — Optional. yyyy-MM-dd.
SubNote — Optional. Subscriber note (overwrites existing).

Example:

{"PatNum": 23, "DateEffective": "2022-09-16", "DateTerm": "2024-12-31", "SubNote": "25% discount to services."}

DiscountPlanSubs DELETE

Deletes an existing DiscountPlanSub. DiscountSubNum required in URL. Version 23.1.12.

DELETE /discountplansubs/14