Skip to main content

Additional fields for list/detail views

​
clinic_client_id
integer
required

The ID of the client this payment link is for.

​
clinic_id
integer
required

The ID of the clinic this payment link is for.

​
entity_ids
integer[]
required

IDs of entities to be paid based on the payment link kind: for INVOICE kind, provide one or more Invoice IDs (e.g., [123, 456]); for CARE_PLAN_PAYMENT_METHOD_UPDATE kind, provide exactly one Patient Care Plan ID (e.g., [456]).

​
expires_on
string<date-time>
required

The timestamp at which this payment link will expire.

​
id
integer
required

The unique identifier for the payment link.

​
is_expired
boolean
required

Whether this payment link has expired.

​
kind
enum<string>
required

The kind of entity to be included in this payment link.

Available options:
INVOICE,
ESTIMATE,
APPOINTMENT,
CARE_PLAN,
CARE_PLAN_PAYMENT_METHOD_UPDATE
​
url
string
required

The URL for the payment link.

​
callback_urls
PaymentLinkCallbackUrlsSchema · object | null

Callback URLs for redirecting after payment completion or cancellation.

​
client_payment_ids
integer[]

The ID's of the client payments associated with this payment link, if any payments have been made.

​
connect_metadata
Connect Metadata · object | null

Metadata to be set by the client on the payment link.

​
custom_text
string | null

Optional plain-text message for the payment link. Notes written in the clinic app as rich text are flattened here; formatting and paragraph breaks are not preserved.

​
is_deleted
boolean
default:false

Whether this payment link has been deleted.