View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.

API reference Models

InvoiceSendOutcomeDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

What a send did beyond moving the invoice's status: whether the invoice email went out and whether the invoice got a payment link. Returned on the send response only, so the caller can warn the operator at the moment the platform knows the recipient was not emailed or has nothing to pay with.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
emailNotSentReason required InvoiceEmailNotSentReason InvoiceEmailNotSentReason Why the invoice email did not go out, or null when the email service accepted it. A message accepted and later bounced reads as sent here. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
NoRecipientEmail The invoice's recipient has no email address.
NoTemplate The email template is missing or could not be rendered.
TransportError The email service refused the message or could not be reached.
Disabled The host is configured to deliver no email at all (log-only mode).
Unexpected Something else stopped the email. The host log has the detail.
paymentLinkNotIssuedReason required InvoicePaymentLinkNotIssuedReason InvoicePaymentLinkNotIssuedReason Why the invoice was sent with no payment link, or null when it has one. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
NothingPayable The invoice has nothing left to pay.
BillerNotMerchant The invoice is not billed by a merchant, so hosted-page ownership cannot be confirmed.
NoDefaultHostedPage The invoice names no hosted page and the merchant has no active payment page to default to.
AmbiguousDefaultHostedPage The invoice names no hosted page and the merchant has more than one active payment page.
NoPermittedPaymentMethod Every payment method the invoice allows is turned off for the merchant.
HostedPageNotFound The hosted page the invoice targets was not found for the invoice's merchant. Covers a deleted page and a page that belongs to another merchant alike, by design.
HostedPageInactive The hosted page the invoice targets is inactive.
SessionRejected The hosted page refused the payment session for another reason; the metadata carries the stable error code.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.