API call 9

Request headers

Request body

Response body

{
  "results": [
    {
      "name": "hs_object_id",
      "label": "Record ID",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "The unique ID for this record. This value is set automatically by HubSpot.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "createdate",
      "label": "Create Date",
      "type": "datetime",
      "fieldType": "date",
      "groupName": "lineiteminformation",
      "description": "The date and time at which this record was created.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_lastmodifieddate",
      "label": "Last Modified Date",
      "type": "datetime",
      "fieldType": "date",
      "groupName": "lineiteminformation",
      "description": "Most recent timestamp of any property update for this record.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "name",
      "label": "Name",
      "type": "string",
      "fieldType": "text",
      "groupName": "lineiteminformation",
      "description": "Name of the product.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "description",
      "label": "Description",
      "type": "string",
      "fieldType": "text",
      "groupName": "lineiteminformation",
      "description": "Full description of the product.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "price",
      "label": "Unit price",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "The cost of the product within the line item.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "quantity",
      "label": "Quantity",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "How many units of this line item are included in this deal.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "amount",
      "label": "Net price",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "The total cost of the line item after applying discounts, multiplied by the quantity.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "discount",
      "label": "Unit discount",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "Discount amount applied to the unit price.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_discount_percentage",
      "label": "Discount percentage",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "Discount percentage applied to the line item.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "recurringbillingfrequency",
      "label": "Recurring billing frequency",
      "type": "enumeration",
      "fieldType": "select",
      "groupName": "lineiteminformation",
      "description": "How often a customer is billed for this line item.",
      "options": [
        {
          "label": "weekly",
          "value": "weekly",
          "displayOrder": 0,
          "hidden": false
        },
        {
          "label": "biweekly",
          "value": "biweekly",
          "displayOrder": 1,
          "hidden": false
        },
        {
          "label": "monthly",
          "value": "monthly",
          "displayOrder": 2,
          "hidden": false
        },
        {
          "label": "quarterly",
          "value": "quarterly",
          "displayOrder": 3,
          "hidden": false
        },
        {
          "label": "per_six_months",
          "value": "per_six_months",
          "displayOrder": 4,
          "hidden": false
        },
        {
          "label": "annually",
          "value": "annually",
          "displayOrder": 5,
          "hidden": false
        },
        {
          "label": "per_two_years",
          "value": "per_two_years",
          "displayOrder": 6,
          "hidden": false
        },
        {
          "label": "per_three_years",
          "value": "per_three_years",
          "displayOrder": 7,
          "hidden": false
        },
        {
          "label": "per_four_years",
          "value": "per_four_years",
          "displayOrder": 8,
          "hidden": false
        },
        {
          "label": "per_five_years",
          "value": "per_five_years",
          "displayOrder": 9,
          "hidden": false
        }
      ],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_sku",
      "label": "SKU",
      "type": "string",
      "fieldType": "text",
      "groupName": "lineiteminformation",
      "description": "Unique product identifier.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_product_id",
      "label": "Product ID",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "The ID of the product this line item was created from. Empty for a line item without a product.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_price_eur",
      "label": "Unit price EUR",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "Unit price in euro.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_price_gbp",
      "label": "Unit price GBP",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "Unit price in pound sterling.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_price_usd",
      "label": "Unit price USD",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "Unit price in US dollars.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_recurring_billing_start_date",
      "label": "Recurring billing start date",
      "type": "date",
      "fieldType": "date",
      "groupName": "lineiteminformation",
      "description": "The date the recurring billing starts, as midnight UTC.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_recurring_billing_end_date",
      "label": "Recurring billing end date",
      "type": "date",
      "fieldType": "date",
      "groupName": "lineiteminformation",
      "description": "The date the recurring billing ends, as midnight UTC.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_recurring_billing_number_of_payments",
      "label": "Number of payments",
      "type": "number",
      "fieldType": "number",
      "groupName": "lineiteminformation",
      "description": "The number of payments for a recurring line item.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_recurring_billing_period",
      "label": "Recurring billing period",
      "type": "string",
      "fieldType": "text",
      "groupName": "lineiteminformation",
      "description": "The billing period as an ISO 8601 duration, such as P12M.",
      "options": [],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_recurring_billing_terms",
      "label": "Recurring billing terms",
      "type": "enumeration",
      "fieldType": "select",
      "groupName": "lineiteminformation",
      "description": "How the recurring billing ends.",
      "options": [
        {
          "label": "autorenew",
          "value": "autorenew",
          "displayOrder": 0,
          "hidden": false
        },
        {
          "label": "fixed",
          "value": "fixed",
          "displayOrder": 1,
          "hidden": false
        }
      ],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    },
    {
      "name": "hs_line_item_currency_code",
      "label": "Line item currency code",
      "type": "enumeration",
      "fieldType": "select",
      "groupName": "lineiteminformation",
      "description": "The currency of the line item.",
      "options": [
        {
          "label": "EUR",
          "value": "EUR",
          "displayOrder": 0,
          "hidden": false
        },
        {
          "label": "GBP",
          "value": "GBP",
          "displayOrder": 1,
          "hidden": false
        },
        {
          "label": "SEK",
          "value": "SEK",
          "displayOrder": 2,
          "hidden": false
        },
        {
          "label": "USD",
          "value": "USD",
          "displayOrder": 3,
          "hidden": false
        }
      ],
      "hubspotDefined": true,
      "displayOrder": -1,
      "hidden": false,
      "formField": false,
      "calculated": false
    }
  ]
}

JSON