COcollectly
payment_plan_request

Send link to the patient to subscribe for payment plan (request payment plan consent).

Changed on

Send link to the patient to subscribe for payment plan (request payment plan consent). Payment plan is created in "not_subscribed" status and starts only when a patient enters the credit card and signs the consent on the patient portal. You must specify the patient's email or phone number to send a consent request. For immediate payment plan creation with existing payment methods use the POST /patients/{patient_id}/payment_plans endpoint

post/practices/{practice_id}/patients/{patient_id}/payment-plans/request

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}/payment-plans/request
  • 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

emailstring email

Patient email to send a consent request

installmentnumber required

Amount to charge every week/2nd week/month according to period_type.

location_idstring nullable

This field determines where to route funds for pre-service payment plans in case multiple bank accounts are connected. Should be empty in other cases.

n_installmentsinteger
period_type'monthly' | 'weekly' | 'biweekly' | 'semimonthly'

Determines the frequency of installments.

phonestring

Patient phone to send a consent request

start_datestring

ISO8601-formatted date string.

:param kwargs: The same keyword arguments that :class:`Field` receives.
total_amountnumber nullable

Total amount to be charged on the payment plan.It is always equal to patient balance at payment plan subscription momentfor the "standard" type.

type'standard' | 'upfront'

"standard" - post-service payment plan, "upfront" - pre-service payment plan

Response

OK

emailstring email

Patient email to send a consent request

installmentnumber required

Amount to charge every week/2nd week/month according to period_type.

location_idstring nullable

This field determines where to route funds for pre-service payment plans in case multiple bank accounts are connected. Should be empty in other cases.

n_installmentsinteger
period_type'monthly' | 'weekly' | 'biweekly' | 'semimonthly'

Determines the frequency of installments.

phonestring

Patient phone to send a consent request

start_datestring

ISO8601-formatted date string.

:param kwargs: The same keyword arguments that :class:`Field` receives.
total_amountnumber nullable

Total amount to be charged on the payment plan.It is always equal to patient balance at payment plan subscription momentfor the "standard" type.

type'standard' | 'upfront'

"standard" - post-service payment plan, "upfront" - pre-service payment plan

Changes