Skip to main content
POST
/
v1
/
invoices
/
{invoiceId}
/
line-item-groups
Create invoice line item group
curl --request POST \
  --url https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "idempotencyKey": "<string>",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotencyKey": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "planInstanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "subtotalAmount": 123,
  "adjustmentAmount": 123,
  "totalAmount": 123,
  "discountAmount": 123,
  "lineItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotencyKey": "<string>",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lineItemGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "totalUsage": 123,
      "subtotalAmount": 123,
      "adjustmentAmount": 123,
      "totalAmount": 123,
      "discountAmount": 123,
      "metadata": {
        "type": "metric"
      },
      "subLineItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "usage": 123,
          "amount": 123,
          "metadata": {
            "type": "fixed_price",
            "fixedPrice": 123
          }
        }
      ],
      "adjustments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "amount": 123
        }
      ],
      "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

​
invoiceId
string<uuid>
required

Body

application/json

Schema for creating a line item group container for an existing one-off invoice. The group is created empty; line items are added via the line-items endpoint. Empty groups are allowed.

​
idempotencyKey
string
required

A unique idempotency key for this group, scoped to the invoice.

Minimum string length: 1
Pattern: ^[a-zA-Z0-9_-]+$
​
productId
string<uuid>
required

The product to associate with this group.

​
startDate
string<date>
required
​
endDate
string<date>
required
​
name
string | null

Optional group name; defaults to the product name when null.

Response

Default Response

​
id
string<uuid>
required
​
idempotencyKey
string
required
​
customerId
string<uuid>
required
​
productId
string<uuid>
required
​
planId
string<uuid> | null
required
​
planInstanceId
string<uuid> | null
required
​
name
string
required
​
startDate
string<date>
required
​
endDate
string<date>
required
​
subtotalAmount
number
required
​
adjustmentAmount
number
required
​
totalAmount
number
required
​
discountAmount
number
required
​
lineItems
object[]
required