Shop invoice link

post/invoices/{id}/link

A fresh private link to an invoice, where the client reads it and sees how to pay; the address is shown once.

Before you call

Credential: Authorization: Bearer $KEY
Scope: shop:write
Mcp: rivier_invoices_link
Graphql: Mutation.shopInvoiceLink
Sdk: shop.invoice.link
Cli: invoices link

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

daysinteger
Default: 30. At least 1. At most 365.
replaceboolean
Default: false.

Responses

201application/json
Success
- urlstringrequired
- tokenstringrequired
- linkobjectrequired
  - idstring (uuid)required
  - kindstringrequired
    One of: quote, proposal, invoice.
  - docIdstring (uuid)required
  - expiresAtstring or nullrequired
  - viewsnumberrequired
  - firstViewedAtstring or nullrequired
  - lastViewedAtstring or nullrequired
  - revokedAtstring or nullrequired
  - createdBystringrequired
  - createdAtstringrequired
  - activebooleanrequired
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/invoices/{id}/link' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "days": 30,
  "replace": false
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown