v38

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-192793126.4 KB
Invoices

Updates an invoice.

patch/invoices/{id}

Path parameters

idstring required

Unique identifier for the invoice.

Example:inv_1234567890

Request body

current_invoice_versionnumber required

Current version of the invoice. Must match the stored version.

Example request

{
  "current_invoice_version": 3,
  "tags": {
    "set": [
      {
        "key": "department",
        "value": "engineering"
      }
    ]
  },
  "line_items": {
    "update": [
      {
        "id": "li_1234567890",
        "price": {
          "amount": "2000"
        }
      }
    ]
  }
}

Response

Success

Example response

{
  "data": {
    "id": "inv_1234567890",
    "workspace_id": "ws_1234567890",
    "status": "active",
    "line_items": [
      {
        "id": "item_1234567890",
        "type": "payout",
        "product_id": "prod_1234567890",
        "amount": "1000",
        "price": {
          "amount": "1000",
          "unit_price": "1000",
          "quantity": 1
        },
        "currency_code": "USD",
        "description": "Professional services for January 2026",
        "user_id": "user_ext_456",
        "tags": [
          {
            "key": "department",
            "value": "engineering"
          }
        ]
      }
    ],
    "created": "2024-01-13T00:00:00Z",
    "modified": "2024-01-13T00:00:00Z",
    "version": 1,
    "tags": [
      {
        "key": "department",
        "value": "engineering"
      }
    ]
  }
}