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

import requests

url = "https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups"

payload = {
    "idempotencyKey": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "name": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '<string>',
    productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    startDate: '2023-12-25',
    endDate: '2023-12-25',
    name: '<string>'
  })
};

fetch('https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => '<string>',
    'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'startDate' => '2023-12-25',
    'endDate' => '2023-12-25',
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"startDate\": \"2023-12-25\",\n  \"endDate\": \"2023-12-25\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"startDate\": \"2023-12-25\",\n  \"endDate\": \"2023-12-25\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"startDate\": \"2023-12-25\",\n  \"endDate\": \"2023-12-25\",\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
      "licenseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lineItemGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "scope": "credit_purchase",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "totalUsage": 123,
      "usageFormat": "unit",
      "subtotalAmount": 123,
      "adjustmentAmount": 123,
      "totalAmount": 123,
      "discountAmount": 123,
      "metadata": {
        "type": "fixed",
        "billingTiming": "in_advance"
      },
      "subLineItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "fixed_price",
          "name": "<string>",
          "description": "<string>",
          "usage": 123,
          "usageFormat": "unit",
          "amount": 123,
          "metadata": {
            "type": "fixed_price",
            "fixedPrice": 123
          }
        }
      ],
      "adjustments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "type": "monetary_discount",
          "amount": 123
        }
      ],
      "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

POST

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

import requests

url = "https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups"

payload = {
    "idempotencyKey": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "name": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '<string>',
    productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    startDate: '2023-12-25',
    endDate: '2023-12-25',
    name: '<string>'
  })
};

fetch('https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => '<string>',
    'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'startDate' => '2023-12-25',
    'endDate' => '2023-12-25',
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"startDate\": \"2023-12-25\",\n  \"endDate\": \"2023-12-25\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"startDate\": \"2023-12-25\",\n  \"endDate\": \"2023-12-25\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/invoices/{invoiceId}/line-item-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"startDate\": \"2023-12-25\",\n  \"endDate\": \"2023-12-25\",\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
      "licenseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lineItemGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "scope": "credit_purchase",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "totalUsage": 123,
      "usageFormat": "unit",
      "subtotalAmount": 123,
      "adjustmentAmount": 123,
      "totalAmount": 123,
      "discountAmount": 123,
      "metadata": {
        "type": "fixed",
        "billingTiming": "in_advance"
      },
      "subLineItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "fixed_price",
          "name": "<string>",
          "description": "<string>",
          "usage": 123,
          "usageFormat": "unit",
          "amount": 123,
          "metadata": {
            "type": "fixed_price",
            "fixedPrice": 123
          }
        }
      ],
      "adjustments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "type": "monetary_discount",
          "amount": 123
        }
      ],
      "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "causations": [
    {
      "message": "<string>",
      "code": "<string>",
      "details": {}
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

API Key Authentication.

Path Parameters

invoiceId

string<uuid>

required

The unique identifier of the invoice to add the line item group to.

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

Start of the period covered by the group.

endDate

string<date>

required

End of the period covered by the group.

name

string | null

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

Response

Schema representing a line item group: a container that gathers the line items generated from one plan instance (or created as a group on one-off invoices). Monetary amounts are integers in cents.

string<uuid>

required

The unique identifier of the line item group in our system.

idempotencyKey

string

required

A unique key that identifies the group within the invoice. Supplied by the caller for one-off groups; generated by the billing engine otherwise.

customerId

string<uuid>

required

The unique identifier of the customer whose consumption this group bills.

productId

string<uuid>

required

The unique identifier of the product this group belongs to.

planId

string<uuid> | null

required

The unique identifier of the plan whose instance generated this group. Null for groups not generated from a plan (e.g. on one-off invoices).

planInstanceId

string<uuid> | null

required

The unique identifier of the plan instance that generated this group. Null for groups not generated from a plan instance.

name

string

required

Display name of the group as it appears on the invoice, typically the plan or product name.

startDate

string<date>

required

Start of the period that the group shows. On contract invoices, it is the period of the group's line item that bills most often, such as the month when a monthly fee is billed with an annual fee. When two line items bill equally often, it is the earlier period.

endDate

string<date>

required

End of the period that the group shows, which startDate describes.

subtotalAmount

number

required

Sum of the group's line item subtotals before adjustments, in cents.

adjustmentAmount

number

required

Net amount of the adjustments applied to the group's line items (discounts and allocation offsets), in cents. Negative when adjustments reduce the amount owed.

totalAmount

number

required

Final group amount, in cents: subtotalAmount + adjustmentAmount.

discountAmount

number

required

The discount portion of adjustmentAmount, in cents (sum of monetary discount adjustments only). Negative when discounts were applied.

lineItems

object[]

required

The line items contained in this group.

Show child attributes