---
title: "Send link to the patient to subscribe for payment plan (request payment plan consent)."
method: POST
path: "/practices/{practice_id}/patients/{patient_id}/payment-plans/request"
tags: ["payment_plan_request"]
---

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

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

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

## Path parameters

- `practice_id` string, required
- `patient_id` string, required

## Request body

- PaymentPlanRequest
  - `email` string, email: Patient email to send a consent request
  - `installment` number, required: Amount to charge every week/2nd week/month according to period_type.
  - `location_id` string, 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_installments` integer
  - `period_type` 'monthly' | 'weekly' | 'biweekly' | 'semimonthly': Determines the frequency of installments.
  - `phone` string: Patient phone to send a consent request
  - `start_date` string: ISO8601-formatted date string. :param kwargs: The same keyword arguments that :class:`Field` receives.
  - `total_amount` number, 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 `200`

OK

- PaymentPlanRequest
  - `email` string, email: Patient email to send a consent request
  - `installment` number, required: Amount to charge every week/2nd week/month according to period_type.
  - `location_id` string, 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_installments` integer
  - `period_type` 'monthly' | 'weekly' | 'biweekly' | 'semimonthly': Determines the frequency of installments.
  - `phone` string: Patient phone to send a consent request
  - `start_date` string: ISO8601-formatted date string. :param kwargs: The same keyword arguments that :class:`Field` receives.
  - `total_amount` number, 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

- **2026-11-03** `a45575a6e4b8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/collectly/apis/partners1/changes/practices/:practice_id/patients/:patient_id/payment-plans/request/post.md)

---

[API](https://skmtc.dev/collectly/apis/partners1.md) - [All operations](https://skmtc.dev/collectly/apis/partners1/llms.txt) - [OpenAPI document](https://skmtc.dev/collectly/apis/partners1/revisions/a45575a6e4b8?raw)