Retry invoice payment
Route
POST
/api/v1/invoices/:id/retry_payment
Usage
- Curl
- Python
- Ruby
- Node.js
- Go
LAGO_URL="https://api.getlago.com"
INVOICE_ID="__YOU_INVOICE_ID__"
API_KEY="__YOUR_API_KEY__"
curl --location --request POST "$LAGO_URL/api/v1/$INVOICE_ID/retry_payment" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json'
from lago_python_client import Client
client = Client(api_key='__YOUR_API_KEY__')
invoice = client.invoices().retry_payment('5eb02857-a71e-4ea2-bcf9-57d8885990ba') # Invoice ID
require 'lago-ruby-client'
client = Lago::Api::Client.new({api_key: '__YOUR_API_KEY__'})
client.invoices.retry_payment('5eb02857-a71e-4ea2-bcf9-57d8885990ba') // Invoice ID
let client = new Client('__API_KEY__')
await client.retryInvoicePayment('id');
import "fmt"
import "github.com/getlago/lago-go-client"
func main() {
lagoClient := lago.New().
SetApiKey("__YOUR_API_KEY__")
invoice, err := lagoClient.Invoice().RetryPayment("__YOUR_INVOICE_ID__")
if err != nil {
// Error is *lago.Error
panic(err)
}
// invoice is *lago.Invoice
fmt.Println(invoice)
// If the invoice has to be generated, the response is empty
// And you will get a webhook `invoice.generated`
}
Responses
- HTTP 200
- HTTP 404
- HTTP 401
- HTTP 405
- The
retry payment
job has been scheduled. Empty response is returned.
{
"status": 404,
"error": "Bad Request",
"code": "invoice_not_found"
}
The invoice
is not found.
{
"status": 401,
"error": "Unauthorized"
}
Access to the API endpoint is unhautorized.
Possible reasons are:
- The
Authorization
header is missing - The
Authorization
header does not contain the API key - The Api key is invalid or expired
{
"status": 405,
"error": "Method Not Allowed",
"code": "message"
}
Possible code messages:
Code message | Description | |
---|---|---|
invalid_status | Payment retry is only available for finalized invoices that are in pending or failed payment status. | |
payment_processor_is_currently_handling_payment | Payment retry is not available if payment processor is already handling the payment. |