Mark an invoice paid

POST /api/v1/users/{id}/invoices/{invoiceId}/pay prm_users_invoices_edit

Records the invoice as settled and stamps paid_on. This is bookkeeping: it does not move money between wallets.

Marking an invoice paid and taking a payment are different operations. This one changes a status; a deposit changes a balance. Doing one does not do the other.

At a glance

Authentication: Staff token or session
Requires permission: prm_users_invoices_edit Edit / pay user invoices
Rate limit: t_mutate

Parameters

Parameter	Description
`id`required path · integer	Subscriber id.
`invoiceId`required path · integer	Invoice id.

Request

curl -X POST "$BASE/api/v1/users/{id}/invoices/{invoiceId}/pay" \
  -H "Authorization: Bearer $XR_TOKEN"

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us