invoice_line_item

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
id	string
object	string
live_mode	boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.
created_at	string
updated_at	string
name	string	The name of the line item, typically a product or SKU name.
description	string	An optional free-form description of the line item.
quantity	integer	The number of units of a product or service that this line item is for. Must be a whole number. Defaults to 1 if not provided.
unit_amount	integer	The cost per unit of the product or service that this line item is for, specified in the invoice currency's smallest unit.
unit_amount_decimal	string	The cost per unit of the product or service that this line item is for, specified in the invoice currency's smallest unit. Accepts decimal strings with up to 12 decimals
direction	string	Either `debit` or `credit`. `debit` indicates that a client owes the business money and increases the invoice's `total_amount` due. `credit` has the opposite intention and effect.
metadata	object	Additional data represented as key-value pairs. Both the key and value must be strings.
amount	integer	The total amount for this line item specified in the invoice currency's smallest unit.
invoice_id	string	The ID of the invoice for this line item.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/invoice_line_item",
  "title": "invoice_line_item",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "object": {
      "type": "string"
    },
    "live_mode": {
      "type": "boolean",
      "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": "string",
      "description": "The name of the line item, typically a product or SKU name."
    },
    "description": {
      "type": "string",
      "description": "An optional free-form description of the line item."
    },
    "quantity": {
      "type": "integer",
      "description": "The number of units of a product or service that this line item is for.           Must be a whole number. Defaults to 1 if not provided."
    },
    "unit_amount": {
      "type": "integer",
      "description": "The cost per unit of the product or service that this line item is for,           specified in the invoice currency's smallest unit."
    },
    "unit_amount_decimal": {
      "type": "string",
      "description": "The cost per unit of the product or service that this line item is for,           specified in the invoice currency's smallest unit. Accepts decimal strings with up to 12 decimals"
    },
    "direction": {
      "type": "string",
      "description": "Either `debit` or `credit`. `debit` indicates that a client owes the business money           and increases the invoice's `total_amount` due. `credit` has the opposite intention and effect."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value",
        "foo": "bar",
        "modern": "treasury"
      },
      "description": "Additional data represented as key-value pairs. Both the key and value must be strings."
    },
    "amount": {
      "type": "integer",
      "description": "The total amount for this line item specified in the invoice currency's smallest unit."
    },
    "invoice_id": {
      "type": "string",
      "description": "The ID of the invoice for this line item."
    }
  },
  "additionalProperties": false,
  "minProperties": 14,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "name",
    "description",
    "quantity",
    "unit_amount",
    "unit_amount_decimal",
    "direction",
    "metadata",
    "amount",
    "invoice_id"
  ]
}