Retry payment

POSThttps://app.speybooks.com/api/v1/admin/orgs/{id}/retry-payment

Attempt to collect a failed invoice payment again. If invoiceId is given, that invoice is retried; otherwise the most recent open invoice for the organisation is used.

Request Body

  • invoiceId: optional. If omitted, the latest open invoice is used

Error responses:

  • 400 { code: "NO_CUSTOMER" }: organisation has no billing customer
  • 400 { code: "NO_OPEN_INVOICE" }: no open invoice to retry
  • 404 { code: "NOT_FOUND" }: organisation not found

Path parameters

idstringrequired
Organisation ID.

Body parameters

invoiceIdstringoptional
Stripe invoice ID to retry. Omit to retry the latest past_due invoice.

Response

200Payment retried. Returns invoice status and amount paid.
Show response fields
amountPaidinteger
invoiceIdstring
paidboolean
statusstring

Error codes

400No Stripe customer or no open invoice.
404Organisation not found.