Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
PUT /v1/invoices//payment-link turns an invoice’s hosted pay link on or off.
PUT /v1/invoices/{invoiceId}/payment-link
invoices:write · Idempotency-Key: optional
true to turn the link on, false to turn it off.curl -X PUT https://api.stg.cleo-pay.com/v1/invoices/d7e8f9a0-b1c2-4d3e-8f4a-5b6c7d8e9f0a/payment-link \
--header "Authorization: Bearer $CLEO_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "enabled": false }'
200 with the invoice. paymentLink.enabled is true only while the customer can pay through it.
| Code | When |
|---|---|
validation_error | Turning on the link of a draft (send it first), of an invoice the customer has not approved yet, or of a paid, void, declined or blocked invoice. |
payments_locked, setup_incomplete, setup_required, feature_unavailable | Turning it on while the business cannot receive. |