FRAGMENT

Billing

B Invoices#

List

#

GET /invoices

Lists all invoices for the workspace

Request
curl -X GET "https://api.us-west-2.fragment.dev/invoices" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json"

Response
{
  "data": [
    {
      "id": "inv_1234567890",
      "workspaceId": "ws_1234567890",
      "status": "active",
      "lineItems": [
        {
          "id": "item_1234567890",
          "type": "payout",
          "product_id": "prod_1234567890",
          "amount": "1000",
          "currencyCode": "USD",
          "description": "Professional services for January 2026",
          "user_id": "user_ext_456"
        }
      ],
      "created": "2024-01-13T00:00:00Z",
      "modified": "2024-01-13T00:00:00Z",
      "version": 1
    }
  ]
}

Create

#

POST /invoices

Creates a new invoice

Request
curl -X POST "https://api.us-west-2.fragment.dev/invoices" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"invoiceId":"invoice_2024_001","lineItems":[{"type":"payout","product_id":"prod_1234567890","amount":"1000","currencyCode":"USD","description":"Professional services for January 2026","user_id":"user_ext_456"}]}'

Response
{
  "data": {
    "id": "inv_1234567890",
    "workspaceId": "ws_1234567890",
    "status": "active",
    "lineItems": [
      {
        "id": "item_1234567890",
        "type": "payout",
        "product_id": "prod_1234567890",
        "amount": "1000",
        "currencyCode": "USD",
        "description": "Professional services for January 2026",
        "user_id": "user_ext_456"
      }
    ],
    "created": "2024-01-13T00:00:00Z",
    "modified": "2024-01-13T00:00:00Z",
    "version": 1
  }
}

Parameters
Name Description
invoiceId (required) - stringUnique identifier for the invoice. Make this the canonical ID from your system for the transaction.
lineItems (required) - arrayList of line items to create with the invoice

Retrieve

#

GET /invoices/{id}

Gets an invoice by ID with balance details

Request
curl -X GET "https://api.us-west-2.fragment.dev/invoices/inv_123" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json"

Response
{
  "data": {
    "id": "inv_1234567890",
    "workspaceId": "ws_1234567890",
    "status": "active",
    "lineItems": [
      {
        "id": "item_1234567890",
        "type": "payout",
        "product_id": "prod_1234567890",
        "amount": "1000",
        "currencyCode": "USD",
        "description": "Professional services for January 2026",
        "user_id": "user_ext_456"
      }
    ],
    "created": "2024-01-13T00:00:00Z",
    "modified": "2024-01-13T00:00:00Z",
    "version": 1
  }
}

Parameters
Name Description
{id} (required) - string-

Update

#

POST /invoices/{id}

Updates an invoice with line item operations

Request
curl -X POST "https://api.us-west-2.fragment.dev/invoices/inv_123" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"version":1,"line_items_update":[]}'

Response
{
  "data": {
    "id": "inv_1234567890",
    "workspaceId": "ws_1234567890",
    "status": "active",
    "lineItems": [
      {
        "id": "item_1234567890",
        "type": "payout",
        "product_id": "prod_1234567890",
        "amount": "1000",
        "currencyCode": "USD",
        "description": "Professional services for January 2026",
        "user_id": "user_ext_456"
      }
    ],
    "created": "2024-01-13T00:00:00Z",
    "modified": "2024-01-13T00:00:00Z",
    "version": 1
  }
}

Parameters
Name Description
{id} (required) - string-
version (required) - numberThe version of the invoice being updated. Must match the current version for the update to succeed.
line_items_update (required) - arrayList of line item operations to apply to the invoice

List History

#

GET /invoices/{id}/history

Gets the version history of an invoice

Request
curl -X GET "https://api.us-west-2.fragment.dev/invoices/inv_123/history" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json"

Response
{
  "data": [
    {
      "id": "inv_1234567890",
      "workspaceId": "ws_1234567890",
      "status": "active",
      "lineItems": [
        {
          "id": "item_1234567890",
          "type": "payout",
          "product_id": "prod_1234567890",
          "amount": "1000",
          "currencyCode": "USD",
          "description": "Professional services for January 2026",
          "user_id": "user_ext_456"
        }
      ],
      "created": "2024-01-13T00:00:00Z",
      "modified": "2024-01-13T00:00:00Z",
      "version": 1
    }
  ]
}

Parameters
Name Description
{id} (required) - string-
©
 FRAGMENT  
2025
○ Light
○ Dark
● System