Api reference
Update invoice
Update an existing invoice.
Related endpoints
PUT /invoices/external/batch— Batch upsert invoices by external IDGET /invoices— List invoicesPOST /invoices— Create invoiceGET /invoices/{id}— Get invoiceDELETE /invoices/{id}— Delete invoicePOST /invoices/{id}/refund— Refund invoicePOST /invoices/{id}/reject— Reject invoiceGET /invoices/{id}/comments— List invoice comments
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
Invoice update details
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://api.revkeen.com/v2/invoices/00000000-0000-0000-0000-000000000000" \ -H "x-api-key: $REVKEEN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "status": "string", "total_minor": 0, "due_date": "string", "subscription_terms": null }'{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"customer_uuid": "e7eefd45-cb13-4c62-b229-e5bbc1362123",
"invoice_number": "string",
"total_minor": 0,
"currency": "string",
"allowed_methods": [
"string"
],
"status": "string",
"due_date": "string",
"custom_fields": {},
"external_source": "practicehub",
"external_type": "appointment",
"external_id": "INV-12345",
"subscription_terms": {
"collection_method": "charge_automatically",
"start_mode": "when_paid",
"start_date": "string",
"duration_type": "until_cancelled",
"duration_count": 12,
"end_date": "string",
"first_payment_behavior": "charge_first_cycle_now"
},
"created_at": "string",
"updated_at": "string"
},
"requestId": "string"
}