Void an invoice | Prolifi

curl -X POST https://api.prolifi.co/api/v1/public/invoices/id/void \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "string",
    "invoice_number": "string",
    "customer_id": "string",
    "subscription_id": "string",
    "status": "pending",
    "due_date": "2023-01-15",
    "issue_date": "2023-01-15",
    "subtotal": 1.1,
    "tax": 1.1,
    "total": 1.1,
    "amount_paid": 1.1,
    "amount_due": 1.1,
    "currency": "string",
    "line_items": [
      {
        "id": "string",
        "description": "string",
        "quantity": 1.1,
        "unit_price": 1.1,
        "amount": 1.1
      }
    ],
    "metadata": {},
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  }
}

Voids an invoice, cancelling it. Voided invoices cannot be collected. An invoice that is already voided cannot be voided again.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the invoice.

Response

Invoice voided successfully

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error