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: SuccessEnvelope_InvoicePaymentLinkResponse_

successboolean
messagestring
codestring
dataInvoicePaymentLinkResponse

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

Code samples

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

bash

curl -X GET 'https://api.ondayzero.com/api/v1/invoices/{invoice_id}/payment-link' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'