Skip to main content
POST
/
v1
/
invoices
/
{invoiceId}
/
line-items
Create invoice line item
curl --request POST \
  --url https://api.useaira.com/v1/invoices/{invoiceId}/line-items \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "idempotencyKey": "<string>",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "amount": 123,
  "name": "<string>",
  "lineItemGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subLineItems": []
}
'
{
  "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 one-off line item on an existing one-off invoice. When subLineItems is provided, the sum of subLineItems.amount must equal amount.

​
idempotencyKey
string
required

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

Minimum string length: 1
Pattern: ^[a-zA-Z0-9_-]+$
​
productId
string<uuid>
required
​
itemId
string<uuid>
required
​
startDate
string<date>
required
​
endDate
string<date>
required
​
amount
number
required
​
name
string | null

Optional line item name; defaults to the item name (or product name as fallback) when null.

​
lineItemGroupId
string<uuid> | null

Optional line item group to attach this line item to. The group must belong to the same invoice.

​
subLineItems
object[]

Optional breakdown of the line item amount into sub-line items. When provided, amounts must sum to amount.

Response

Default Response

​
id
string<uuid>
required
​
idempotencyKey
string
required
​
customerId
string<uuid>
required
​
productId
string<uuid>
required
​
resourceId
string<uuid> | null
required
​
lineItemGroupId
string<uuid> | null
required
​
name
string
required
​
scope
enum<string>
required
Available options:
credit_purchase,
contract_minimum_amount,
plan_minimum_amount,
plan_fixed_amount,
metric,
additional_charge,
one_off,
tax_gross_up
​
startDate
string<date>
required
​
endDate
string<date>
required
​
totalUsage
number | null
required
​
usageFormat
enum<string> | null
required
Available options:
unit,
currency,
null
​
subtotalAmount
number
required
​
adjustmentAmount
number
required
​
totalAmount
number
required
​
discountAmount
number
required
​
metadata
object
required
​
subLineItems
object[]
required
​
adjustments
object[]
required
​
itemId
string<uuid> | null