v1

latestOpenAPI 3.0.22026-07-2414318.0 KB

subscriptions

Retrieve

Retrieve a list of patient subscriptions.

get/practices/{practice_id}/patients/{patient_id}/subscriptions

Path parameters

practice_idstring required

Practice ID in which the requested resource exists

patient_idstring required

Patient ID from your integration who owns the resource

Query parameters

pageinteger

Page number of dataset

per_pageinteger

Custom page size of dataset

sortstring

String with a comma-separated list of parameters by which to sort the dataset. To specify a descending order, add a "-" character before the parameter. For example, ?sort=-created_at,id

Response

amountnumber required

billing_provider_idinteger required

cadence'monthly' | 'weekly' | 'biweekly' required

{"stackTrail":"components:schemas:PartnersAPISubscription:properties:client_id","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:PartnersAPISubscription:properties:company_id","oasType":"schema","type":"unknown"}

cpt_codestring required

diagnosis_codestring required

diagnosis_code_typestring required

idstring

location_idstring required

namestring nullable required

{"stackTrail":"components:schemas:PartnersAPISubscription:properties:patient_id","oasType":"schema","type":"unknown"}

payment_method_idinteger

place_of_service'06' | '53' | '52' | '49' | '04' | '07' | '12' | '25' | '21' | '71' | '18' | '65' | '02' | '41' | '03' | '17' | '09' | '05' | '50' | '11' | '32' | '99' | '23' | '08' | '57' | '14' | '51' | '58' | '22' | '15' | '33' | '27' | '19' | '61' | '62' | '42' | '16' | '55' | '31' | '01' | '66' | '34' | '60' | '54' | '24' | '10' | '72' | '20' | '26' | '13' | '56' | '81' required

rendering_provider_idinteger required

secretstring

start_datestring date required

status'pending' | 'active' | 'canceled' | 'failed'