v38

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

Creates an invoice.

post/invoices

Request body

invoice_idstring required

Unique ID for the invoice.

Example request

{
  "invoice_id": "invoice_2024_001",
  "line_items": [
    {
      "type": "payout",
      "product_id": "prod_1234567890",
      "amount": "1000",
      "currency_code": "USD",
      "description": "Professional services for January 2026",
      "user": {
        "id": "user_abc123"
      }
    }
  ],
  "tags": [
    {
      "key": "department",
      "value": "engineering"
    }
  ]
}

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"
      }
    ]
  }
}