Skip to main content

List Invoice Additions (v1)

Get all invoice additions for a workspace.

Method & Path​

GET /api/v1/admin/workspaces/:workspaceId/invoice-additions

Description​

Retrieves all invoice additions (custom charges) for a specific workspace. Invoice additions are non-discountable charges that are added to the monthly subscription invoice.

Authentication​

Required: Admin authentication with businesses.manage permission.

Headers​

Authorization: Bearer <admin_token>
Content-Type: application/json

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesThe workspace ID

Query Parameters​

None.

Request Body​

None.

Response 200 OK​

{
  "additions": [
    {
      "id": "507f1f77bcf86cd799439013",
      "reason": "Additional 1GB storage",
      "quantity": 1,
      "unitPrice": 2.00,
      "total": 2.00,
      "createdAt": "2024-01-15T10:00:00.000Z",
      "createdBy": "507f1f77bcf86cd799439014"
    },
    {
      "id": "507f1f77bcf86cd799439015",
      "reason": "Premium support",
      "quantity": 1,
      "unitPrice": 50.00,
      "total": 50.00,
      "createdAt": "2024-01-20T10:00:00.000Z",
      "createdBy": "507f1f77bcf86cd799439014"
    }
  ]
}

Common Errors​

  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions (missing businesses.manage permission)
  • 404 Not Found: Workspace not found
  • 400 Bad Request: Invalid workspace ID format
  • 500 Internal Server Error: Server error