Get Started

Get invoice payment link

GET/api/v1/invoices/{invoice_id}/payment-link

Return the Stripe-hosted payment link for an invoice so it can be paid online. Read-only — available once the invoice has been finalized/sent.

Operation ID: get_invoice_payment_link_api_v1_invoices__invoice_id__payment_link_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

invoice_idstring · uuidrequired

Responses

200Successful Response

Schema: InvoicePaymentLinkResponse

invoice_idstringrequired

UUID of the invoice.

statusstringrequired

Current invoice status.

hosted_invoice_urlstringrequired

Stripe-hosted page where the invoice can be paid online.

already_paidboolean

True if the invoice is already fully paid.

totalinteger

Total amount in cents.

balance_dueinteger

Remaining balance in cents.

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject