Create a payment link
Creates a new payment link that can be sent to a clinic client (pet parent) to collect a payment.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Fields required to create a PaymentLink
The ID of the client this payment link is for.
The ID of the clinic this payment link is for.
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]).
The kind of entity to be included in this payment link.
INVOICE, CARE_PLAN_PAYMENT_METHOD_UPDATE Callback URLs for redirecting after payment completion or cancellation.
Metadata to be set by the client on the payment link.
Optional plain-text message for the payment link (max 500 characters). Send a string only — rich-text JSON is not accepted. The value is stored internally as rich text.
Response
Created
Additional fields for list/detail views
The ID of the client this payment link is for.
The ID of the clinic this payment link is for.
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]).
The timestamp at which this payment link will expire.
The unique identifier for the payment link.
Whether this payment link has expired.
The kind of entity to be included in this payment link.
INVOICE, ESTIMATE, APPOINTMENT, CARE_PLAN, CARE_PLAN_PAYMENT_METHOD_UPDATE The URL for the payment link.
Callback URLs for redirecting after payment completion or cancellation.
The ID's of the client payments associated with this payment link, if any payments have been made.
Metadata to be set by the client on the payment link.
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.
Whether this payment link has been deleted.