COcollectly
subscriptions

Create

Changed on

Create a new patient subscription with PENDING status.

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

Request

  • Base URL
    sandbox.collectly.co/api/api/partners/v1 (relative, and the document’s source URL is not known)
  • URL
    sandbox.collectly.co/api/api/partners/v1/practices/{practice_id}/patients/{patient_id}/subscriptions
  • Auth
    API key in header Authorization

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

Request body

amountnumber required
billing_provider_idinteger required
cadence'monthly' | 'weekly' | 'biweekly' required
client_idunknown
company_idunknown
cpt_codestring required
diagnosis_codestring required
diagnosis_code_typestring required
idstring
location_idstring required
namestring nullable required
patient_idunknown
payment_method_idinteger
place_of_service'65' | '56' | '04' | '33' | '50' | '06' | '32' | '20' | '81' | '41' | '60' | '23' | '51' | '01' | '34' | '62' | '31' | '52' | '22' | '72' | '13' | '57' | '10' | '49' | '61' | '03' | '09' | '54' | '55' | '14' | '66' | '05' | '99' | '24' | '08' | '21' | '17' | '27' | '07' | '19' | '18' | '11' | '12' | '58' | '02' | '53' | '42' | '16' | '71' | '15' | '25' | '26' required
rendering_provider_idinteger required
secretstring
start_datestring date required
status'active' | 'pending'

Response

OK

amountnumber required
billing_provider_idinteger required
cadence'monthly' | 'weekly' | 'biweekly' required
client_idunknown
company_idunknown
cpt_codestring required
diagnosis_codestring required
diagnosis_code_typestring required
idstring
location_idstring required
namestring nullable required
patient_idunknown
payment_method_idinteger
place_of_service'65' | '56' | '04' | '33' | '50' | '06' | '32' | '20' | '81' | '41' | '60' | '23' | '51' | '01' | '34' | '62' | '31' | '52' | '22' | '72' | '13' | '57' | '10' | '49' | '61' | '03' | '09' | '54' | '55' | '14' | '66' | '05' | '99' | '24' | '08' | '21' | '17' | '27' | '07' | '19' | '18' | '11' | '12' | '58' | '02' | '53' | '42' | '16' | '71' | '15' | '25' | '26' required
rendering_provider_idinteger required
secretstring
start_datestring date required
status'active' | 'pending'

Changes

  • a45575a6e4b8Revision changes
    • breaking

      removed the enum value canceled of the request property

    • breaking

      removed the enum value failed of the request property

    • info

      the request optional property became not read-only

    • info

      the response optional property became not read-only for the status

    • info

      removed the canceled enum value from the response property for the response status

    • info

      removed the failed enum value from the response property for the response status