Search product lines

Operation ID: searchAccountingProductLines

Group: Accounting › Products › Product Lines

Open in the interactive reference

POST /accounting/product-lines/search

Read-only: A read that takes its filters in the body. Changes nothing, and ignores Idempotency-Key.

Searches product lines.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Request body

Required, application/json: searchAccountingProductLinesInput.

Field Type Required Description
filters object no The filters to apply. A product line must match every filter you send. Omit to return all product lines.
filters.term string no Limits results to product lines whose name or product line number contains this text. The match is case-insensitive.
filters.productId string no Limits results to the product lines of this product. See id on GET accounting/products/:id.
filters.productLineNumber string no Limits results to the product line with this product line number. The match is exact.
filters.crmProductId string no Limits results to product lines with this CRM identifier. The match is exact.
filters.lineType string no Limits results to product lines of this type. Accepted values: 'recurring', 'oneTime', 'commitWithOverage', 'payAsYouGo', 'usage', 'prepaid', 'billableTime', 'billableTravelExpense', 'billablePassThrough'.
filters.priceModel string no Limits results to product lines with this price model. Accepted values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'.
filters.pricingTerm string no Limits results to product lines with this pricing term. Accepted values: 'monthly', 'biMonthly', 'once', 'quarterly', 'semiAnnually', 'annually'.
filters.invoiceFrequency string no Limits results to product lines with this invoice frequency. Accepted values: 'monthly', 'biMonthly', 'quarterly', 'semiAnnually', 'annually', 'once', 'custom', 'template', 'milestone', 'allAtOnce', 'termEnd'.
filters.unitOfMeasure string no Limits results to product lines with this unit of measure. Accepted values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'.
filters.taxMode string no Limits results to product lines with this tax mode. Accepted values: 'TaxInclusive', 'TaxExclusive'.
filters.enforceListPrice boolean no Limits results to product lines that enforce, or do not enforce, the list price.
filters.hasUsage boolean no Limits results to product lines that have, or do not have, a paired 'usage' line.
filters.parentProductLineId string no Limits results to the 'usage' line paired with this product line. See id on GET accounting/product-lines/:id.
filters.dataSource string no Limits results to product lines from this source system or import job. The match is exact. Example: 'Salesforce'.
filters.createdDate object no Limits results by the date and time the product line was created. Bounds are inclusive.
filters.createdDate.start string no The inclusive lower bound, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
filters.createdDate.end string no The inclusive upper bound, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
filters.lastModifiedDate object no Limits results by the date and time the product line last changed. Bounds are inclusive.
filters.lastModifiedDate.start string no The inclusive lower bound, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
filters.lastModifiedDate.end string no The inclusive upper bound, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
filters.externalIdentifier object no Limits results to product lines with this external identifier. Send both fieldName and value.
filters.externalIdentifier.fieldName string yes The configured field name of the external identifier, not its display label. A name that is not configured for product lines fails with UNKNOWN_EXTERNAL_IDENTIFIER.
filters.externalIdentifier.value string yes The identifier's value in the source system. The match is exact and case-sensitive.
page object no The pagination controls. Omit for the first page.
page.cursor string no The cursor from the previous response's pagination.nextCursor. Omit for the first page.
page.size number no The number of product lines per page. Defaults to 50. A value above 200 is treated as 200, not rejected. 
{
  "filters": {
    "term": "<term>",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productLineNumber": "<productLineNumber>",
    "crmProductId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lineType": "<lineType>",
    "priceModel": "<priceModel>",
    "pricingTerm": "<pricingTerm>",
    "invoiceFrequency": "<invoiceFrequency>",
    "unitOfMeasure": "<unitOfMeasure>",
    "taxMode": "<taxMode>",
    "enforceListPrice": true,
    "hasUsage": true,
    "parentProductLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dataSource": "<dataSource>",
    "createdDate": {
      "start": "<start>",
      "end": "<end>"
    },
    "lastModifiedDate": {
      "start": "<start>",
      "end": "<end>"
    },
    "externalIdentifier": {
      "fieldName": "<fieldName>",
      "value": "<value>"
    }
  },
  "page": {
    "cursor": "<cursor>",
    "size": 0
  }
}

Response

200 Success

Under data (searchAccountingProductLinesOutput):

Field Type Required Description
items array<object> yes The product lines on this page. An empty array when nothing matches.
items[].id string yes The unique identifier for the product line.
items[].productId string yes The product the product line belongs to. See id on GET accounting/products/:id.
items[].productName string no The display name of the product. See productName on GET accounting/products/:id.
items[].productLineNumber string no The product line number, assigned by the system and unique within the tenant. Example: 'PL-1001'.
items[].name string yes The name of the product line.
items[].lineType string no The type of product line. Possible values: 'recurring', 'oneTime', 'commitWithOverage', 'payAsYouGo', 'usage', 'prepaid', 'billableTime', 'billableTravelExpense', 'billablePassThrough'.
items[].priceModel string no How the product line is priced. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'.
items[].pricingTerm string no The pricing term of the product line. Possible values: 'monthly', 'biMonthly', 'once', 'quarterly', 'semiAnnually', 'annually'.
items[].invoiceFrequency string no How often the product line is invoiced. Possible values: 'monthly', 'biMonthly', 'quarterly', 'semiAnnually', 'annually', 'once', 'custom', 'template', 'milestone', 'allAtOnce', 'termEnd'.
items[].unitOfMeasure string no The unit the product line's quantities are measured in. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'.
items[].taxMode string no How the product line's prices are quoted for tax. Possible values: 'TaxInclusive', 'TaxExclusive'. Absent if no tax provider was enabled in your tenant when the product line was last saved.
items[].enforceListPrice boolean no Whether the list price of the product line is enforced. When true, the list price comes from the price book and can't be changed on a sales order, a quote, or a subscription change. An unset value counts as true.
items[].hasUsage boolean no Whether the product line has a paired 'usage' line. True for 'prepaid' lines, and for 'recurring' lines whose priceModel is 'thresholdBased' or whose commitInvoicing has a value.
items[].hasBeenUsed boolean no Whether the product line is on at least one sales order.
items[].commitInvoicing string no When the minimum spend commit of a 'recurring' product line is invoiced. Possible values: 'advance', 'arrears'. Absent when the product line has no minimum spend commit.
items[].prepaidBalanceOverConsumptionBehavior string no What happens when usage exceeds the prepaid balance. Possible values: 'allowNegative', 'overage'. Applies only when lineType is 'prepaid'.
items[].prepaidBalanceRolloverAtRenewal boolean no Whether the remaining prepaid balance rolls over at renewal. Applies only when lineType is 'prepaid'.
items[].parentProductLineId string no The product line this 'usage' line is paired with. See id on GET accounting/product-lines/:id. Absent when the product line is not a paired 'usage' line.
items[].crmProductId string no The product line's identifier in an external CRM system.
items[].dataSource string no The source system or import job that produced the product line. Examples: 'Salesforce', 'NetSuite', 'Stripe'.
items[].createdDate date-time no The date and time the product line was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].lastModifiedDate date-time yes The date and time the product line last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].productLineTaxes array<object> no The tax records of the product line. Absent when the product line has none.
items[].productLineTaxes[].id string yes The unique identifier for the tax record.
items[].productLineTaxes[].taxCode string yes The tax code, as defined by the configured tax provider.
items[].productLineTaxes[].engine string yes The tax engine that computes this tax. Possible values: 'avalara', 'anrok', 'everestTaxEngine', 'manualTax', 'none'.
items[].productLineTaxes[].country string no The country the tax record applies in. Format ISO 3166-1, for example 'US'.
items[].productLineTaxes[].entityId string no The legal entity this tax record applies under. See id on GET base/entities.
items[].pricingHeaders array<object> no The pricing headers of the product line, each with its price book entries. Absent when the product line has no pricing.
items[].pricingHeaders[].id string yes The unique identifier for the pricing header. See id on GET accounting/pricing/:id.
items[].pricingHeaders[].headerNumber string no The pricing header number, assigned by the system and unique within the tenant.
items[].pricingHeaders[].priceBookId string no The price book this header belongs to. See id on GET accounting/price-books/:id.
items[].pricingHeaders[].priceBookName string no The display name of the price book. See priceBookName on GET accounting/price-books/:id.
items[].pricingHeaders[].currency string yes The currency the header's prices are in. Format ISO 4217, for example 'USD'.
items[].pricingHeaders[].validFrom date yes The first date the header's prices are effective, inclusive. Format YYYY-MM-DD.
items[].pricingHeaders[].validTo date no The last date the header's prices are effective, inclusive. Format YYYY-MM-DD. Absent for a header with no end date.
items[].pricingHeaders[].priceBookEntries array<object> yes The price book entries of the pricing header. For a product line priced 'tiered', 'volume', 'stairstep', or 'thresholdBased', each entry is one tier: a quantity range with its own price. A 'flat' or 'perUnit' line has one entry, and a 'rateCard' line has one entry per rate-card entry.
items[].pricingHeaders[].priceBookEntries[].id string yes The unique identifier for the price book entry.
items[].pricingHeaders[].priceBookEntries[].priceBookEntryNumber string no The price book entry number, assigned by the system.
items[].pricingHeaders[].priceBookEntries[].listPrice decimal no The list price, in the header currency. On a rate-card entry, the list price is the rate.
items[].pricingHeaders[].priceBookEntries[].fromQuantity decimal no The lowest quantity in the tier, inclusive. Used only when the product line is priced 'tiered', 'volume', 'stairstep', or 'thresholdBased'.
items[].pricingHeaders[].priceBookEntries[].toQuantity decimal no The highest quantity in the tier, inclusive. Absent on the top tier, which has no upper limit.
items[].pricingHeaders[].priceBookEntries[].priceModel string no How the tier prices its quantity. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry object no The rate-card entry attached to this price book entry. Absent when the entry is not rate-card priced.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.id string yes The unique identifier for the rate-card entry.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.billableComponentId string no The unique identifier of the billable component this rate-card entry prices. No endpoint returns billable components.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.unitOfMeasure string yes The unit the rate is quoted in. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.description string no A description of the rate-card entry. The description distinguishes the entry from other rate-card entries on the same billable component.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.usageType string no How usage is measured against this entry. Possible values: 'consumption', 'overage', 'thresholdCounter', 'payg'.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.billableUnitOfMeasure string no The unit used when billing this entry. Possible values: 'instance', 'gigabyte', 'terabyte', 'user', 'seat', 'minute', 'hour', 'day', 'month', 'each', 'license', 'activeUser', 'megabyte', 'message', 'text', 'platform', 'employee', 'personnel', 'credit', 'currency', 'package', 'case', 'word', 'record'.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.conversion decimal no The multiplier that converts unitOfMeasure quantities into billableUnitOfMeasure quantities.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.invoiceFrequency string no How often usage on this entry is invoiced. Possible values: 'monthly', 'biMonthly', 'quarterly', 'semiAnnually', 'annually', 'once', 'custom', 'template', 'milestone', 'allAtOnce', 'termEnd'.
items[].pricingHeaders[].priceBookEntries[].rateCardEntry.priceModel string no How the rate-card entry's price is calculated. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'. Absent when no price model was set on the rate-card entry.
items[].externalIdentifiers array<object> no External identifiers owned by other systems, at most one per fieldName. Absent when the product line has none.
items[].externalIdentifiers[].fieldName string yes The configured field name of the external identifier, not its display label.
items[].externalIdentifiers[].value string yes The identifier's value in the source system.
items[].externalIdentifiers[].externalUrl string no An absolute http or https link to the object in the source system. Absent when none is set.
pagination object yes The pagination information for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as page.cursor. Absent on the last page.
pagination.hasMore boolean yes True when more product lines remain beyond this page. 
{
  "data": {
    "items": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "productName": "<productName>",
        "productLineNumber": "<productLineNumber>",
        "name": "<name>",
        "lineType": "<lineType>",
        "priceModel": "<priceModel>",
        "pricingTerm": "<pricingTerm>",
        "invoiceFrequency": "<invoiceFrequency>",
        "unitOfMeasure": "<unitOfMeasure>",
        "taxMode": "<taxMode>",
        "enforceListPrice": true,
        "hasUsage": true,
        "hasBeenUsed": true,
        "commitInvoicing": "<commitInvoicing>",
        "prepaidBalanceOverConsumptionBehavior": "<prepaidBalanceOverConsumptionBehavior>",
        "prepaidBalanceRolloverAtRenewal": true,
        "parentProductLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "crmProductId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "dataSource": "<dataSource>",
        "createdDate": "2026-01-15T09:30:00.000Z",
        "lastModifiedDate": "2026-01-15T09:30:00.000Z",
        "productLineTaxes": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "taxCode": "<taxCode>",
            "engine": "<engine>",
            "country": "<country>",
            "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        ],
        "pricingHeaders": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "headerNumber": "<headerNumber>",
            "priceBookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "priceBookName": "<priceBookName>",
            "currency": "<currency>",
            "validFrom": "2026-01-15",
            "validTo": "2026-01-15",
            "priceBookEntries": [
              null
            ]
          }
        ],
        "externalIdentifiers": [
          {
            "fieldName": "<fieldName>",
            "value": "<value>",
            "externalUrl": "<externalUrl>"
          }
        ]
      }
    ],
    "pagination": {
      "nextCursor": "<nextCursor>",
      "hasMore": true
    }
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
INVALID_TIMESTAMP 400
UNKNOWN_EXTERNAL_IDENTIFIER 400

Statuses