POST
/
invoice_line_items
curl --request POST \
  --url https://api.withorb.com/v1/invoice_line_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "start_date": "2023-09-22",
  "end_date": "2023-09-22",
  "quantity": 1,
  "invoice_id": "4khy3nwzktxv7",
  "name": "Item Name",
  "amount": "12.00"
}'
{
  "amount": "7.00",
  "discount": {
    "discount_type": "percentage",
    "applies_to_price_ids": [
      "h74gfhdjvn7ujokd",
      "7hfgtgjnbvc3ujkl"
    ],
    "reason": "<string>",
    "percentage_discount": 0.15
  },
  "end_date": "2022-02-01T08:00:00+00:00",
  "grouping": "<string>",
  "minimum": {
    "minimum_amount": "<string>",
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "minimum_amount": "<string>",
  "maximum": {
    "maximum_amount": "<string>",
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "maximum_amount": "<string>",
  "adjustments": [
    {
      "id": "<string>",
      "is_invoice_level": true,
      "filters": [
        {
          "field": "price_id",
          "operator": "includes",
          "values": [
            "<string>"
          ]
        }
      ],
      "reason": "<string>",
      "adjustment_type": "usage_discount",
      "usage_discount": 123,
      "amount": "<string>"
    }
  ],
  "name": "Fixed Fee",
  "quantity": 1,
  "start_date": "2022-02-01T08:00:00+00:00",
  "subtotal": "9.00",
  "adjusted_subtotal": "5.00",
  "credits_applied": "6.00",
  "partially_invoiced_amount": "4.00",
  "sub_line_items": [
    {
      "amount": "9.00",
      "name": "Tier One",
      "quantity": 5,
      "grouping": {
        "key": "region",
        "value": "west"
      },
      "type": "matrix",
      "matrix_config": {
        "dimension_values": [
          "<string>"
        ]
      }
    }
  ],
  "tax_amounts": [
    {
      "tax_rate_description": "<string>",
      "tax_rate_percentage": "<string>",
      "amount": "<string>"
    }
  ],
  "id": "<string>",
  "price": {
    "metadata": {},
    "id": "<string>",
    "name": "<string>",
    "external_price_id": "<string>",
    "price_type": "usage_price",
    "model_type": "unit",
    "created_at": "2023-11-07T05:31:56Z",
    "cadence": "one_time",
    "billing_cycle_configuration": {
      "duration": 123,
      "duration_unit": "day"
    },
    "invoicing_cycle_configuration": {
      "duration": 123,
      "duration_unit": "day"
    },
    "billable_metric": {
      "id": "<string>"
    },
    "dimensional_price_configuration": {
      "dimensional_price_group_id": "<string>",
      "dimension_values": [
        "<string>"
      ]
    },
    "fixed_price_quantity": 123,
    "plan_phase_order": 123,
    "currency": "<string>",
    "conversion_rate": 123,
    "item": {
      "id": "<string>",
      "name": "<string>"
    },
    "credit_allocation": {
      "currency": "<string>",
      "allows_rollover": true
    },
    "discount": {
      "discount_type": "percentage",
      "applies_to_price_ids": [
        "h74gfhdjvn7ujokd",
        "7hfgtgjnbvc3ujkl"
      ],
      "reason": "<string>",
      "percentage_discount": 0.15
    },
    "minimum": {
      "minimum_amount": "<string>",
      "filters": [
        {
          "field": "price_id",
          "operator": "includes",
          "values": [
            "<string>"
          ]
        }
      ]
    },
    "minimum_amount": "<string>",
    "maximum": {
      "maximum_amount": "<string>",
      "filters": [
        {
          "field": "price_id",
          "operator": "includes",
          "values": [
            "<string>"
          ]
        }
      ]
    },
    "maximum_amount": "<string>",
    "unit_config": {
      "unit_amount": "<string>"
    }
  },
  "usage_customer_ids": [
    "<string>"
  ],
  "filter": "<string>"
}

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Body

application/json

Response

201
application/json
Created

The response is of type object.