COcollectly
payment_plans

Create a new payment plan for a patient.

Changed on

Create a new payment plan for a patient.

    There are two types of payment plans:
    1. `type: "standard"`. The standard post-service payment plan may be created only in case there is an outstanding
        patient balance. Standard payment plan checks the current patient balance on every installment and charges
        `installment` amount, but not more than the current balance of the patient.
        Payment plan also stops when the total installments sum reaches the "total_amount". The last installment in
        this case may be less than the `installment`. E.g. plan for `total_amount` of $100 and installment of $40
        the last installment amount is $20.

    2. type: "upfront". This is a pre-service payment plan. It does not check the current patient balance, may be
        started with any patient balance and will be charged up to a "total_amount".

    One of the `collectly_payment_method_id`, `external_payment_method_id` is required since
    payment plan requires a payment method. `external_payment_method_id` can be used only for patients that
    have `metadata.stripe_customer_id` set.
post/practices/{practice_id}/patients/{patient_id}/payment-plans

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
  • 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

collectly_idstring

Unique Collectly resource ID

collectly_payment_method_idstring nullable

Collectly payment method ID which you can obtain from "/payment-methods" endpoint

created_atunknown
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

The total count of planned payments for this payment plan.

next_payment_datestring date

datetime of the next planned charge

payments_madeinteger

The count of already charged payments for this payment plan.

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

Determines the frequency of installments.

start_datestring date

ISO-8601 date format. The date when the first installment will be charged. Must not be in the past. Successive installment dates are computed according to the "period_type". Convert the start date to UTC timezone.

status'not_subscribed' | 'subscribed' | 'paid' | 'cancelled' | 'declined' | 'failed' nullable

Current status of the payment plan

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

collectly_idstring

Unique Collectly resource ID

collectly_payment_method_idstring nullable

Collectly payment method ID which you can obtain from "/payment-methods" endpoint

created_atunknown
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

The total count of planned payments for this payment plan.

next_payment_datestring date

datetime of the next planned charge

payments_madeinteger

The count of already charged payments for this payment plan.

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

Determines the frequency of installments.

start_datestring date

ISO-8601 date format. The date when the first installment will be charged. Must not be in the past. Successive installment dates are computed according to the "period_type". Convert the start date to UTC timezone.

status'not_subscribed' | 'subscribed' | 'paid' | 'cancelled' | 'declined' | 'failed' nullable

Current status of the payment plan

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