COcollectly
payment_plans

Update the payment plan or reschedule a regular payment date.

Changed on

Update the payment plan or reschedule a regular payment date.

    Properties you can update for any payment plan type:
      - 'start_date' - all next installments will be charged starting from this date.
         The date is required when you change a period type or you update a plan with missed payments.
         The start date must not be in the past. The interval between the last scheduled
         payment to the new start date must be no more than two plan periods (month, 2 weeks, week).
      - 'installment'
      - 'period_type'
      - 'collectly_payment_method_id'
      - 'external_payment_method_id' - can be used only for patients that have `metadata.stripe_customer_id` set
    If you update an upfront payment plan you can additionally set new 'total_amount'.
    All changes will take effect immediately.
patch/practices/{practice_id}/patients/{patient_id}/payment-plans/{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/{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

payment_plansstring required

Resource Identifier

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