Retrieve a pricing header

Operation ID: getAccountingPricing

Group: Accounting › Products › Product Lines

Open in the interactive reference

GET /accounting/pricing/{id}

Read-only: Reads and returns; changes nothing.

Retrieves a pricing header. Use the pricing header's id, not its headerNumber.

The response includes the pricing header's price book entries, with their rate-card entries and external identifiers.

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.
id path string yes The unique identifier of the pricing header you want to retrieve.

Response

200 Success

Under data (getAccountingPricingOutput):

Field Type Required Description
id string yes The unique identifier for the pricing header.
headerNumber string no The pricing header number, assigned by the system and unique within the tenant. Absent while none has been assigned.
productLineId string yes The product line this pricing header prices. See id on GET accounting/product-lines/:id.
productLineName string no The name of the product line. See name on GET accounting/product-lines/:id.
productLineNumber string no The product line number. See productLineNumber on GET accounting/product-lines/:id.
productId string no The product the product line belongs to. See id on GET accounting/products/:id.
productName string no The display name of the product. See productName on GET accounting/products/:id.
priceBookId string yes The price book this header belongs to. See id on GET accounting/price-books/:id.
priceBookName string no The display name of the price book. See priceBookName on GET accounting/price-books/:id.
currency string yes The currency the header's prices are in. Format ISO 4217, for example 'USD'.
validFrom date yes The first date the header's prices are effective, inclusive. Format YYYY-MM-DD.
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.
dataSource string no The source system or import job that produced the pricing header. Examples: 'Salesforce', 'NetSuite', 'Stripe'.
hasBeenUsed boolean no Whether at least one sales order line uses this pricing header.
createdDate date-time no The date and time the pricing header was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate date-time yes The date and time the pricing header last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
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. An empty array when the header has none.
priceBookEntries[].id string yes The unique identifier for the price book entry.
priceBookEntries[].priceBookEntryNumber string no The price book entry number, assigned by the system.
priceBookEntries[].listPrice decimal no The list price, in the header currency. On a rate-card entry, the list price is the rate.
priceBookEntries[].fromQuantity decimal no The lowest quantity in the tier, inclusive. Used only when the product line is priced 'tiered', 'volume', 'stairstep', or 'thresholdBased'.
priceBookEntries[].toQuantity decimal no The highest quantity in the tier, inclusive. Absent on the top tier, which has no upper limit.
priceBookEntries[].priceModel string no How the tier prices its quantity. Possible values: 'flat', 'perUnit', 'tiered', 'volume', 'stairstep', 'rateCard', 'thresholdBased'.
priceBookEntries[].rateCardEntry object no The rate-card entry attached to this price book entry. Absent when the entry is not rate-card priced.
priceBookEntries[].rateCardEntry.id string yes The unique identifier for the rate-card entry.
priceBookEntries[].rateCardEntry.billableComponentId string no The unique identifier of the billable component this rate-card entry prices. No endpoint returns billable components.
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'.
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.
priceBookEntries[].rateCardEntry.usageType string no How usage is measured against this entry. Possible values: 'consumption', 'overage', 'thresholdCounter', 'payg'.
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'.
priceBookEntries[].rateCardEntry.conversion decimal no The multiplier that converts unitOfMeasure quantities into billableUnitOfMeasure quantities.
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'.
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.
priceBookEntries[].externalIdentifiers array<object> no External identifiers owned by other systems, at most one per fieldName. Absent when the price book entry has none.
priceBookEntries[].externalIdentifiers[].fieldName string yes The configured field name of the external identifier, not its display label.
priceBookEntries[].externalIdentifiers[].value string yes The identifier's value in the source system.
priceBookEntries[].externalIdentifiers[].externalUrl string no An absolute http or https link to the object in the source system. Absent when none is set. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "headerNumber": "<headerNumber>",
    "productLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productLineName": "<productLineName>",
    "productLineNumber": "<productLineNumber>",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productName": "<productName>",
    "priceBookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "priceBookName": "<priceBookName>",
    "currency": "<currency>",
    "validFrom": "2026-01-15",
    "validTo": "2026-01-15",
    "dataSource": "<dataSource>",
    "hasBeenUsed": true,
    "createdDate": "2026-01-15T09:30:00.000Z",
    "lastModifiedDate": "2026-01-15T09:30:00.000Z",
    "priceBookEntries": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "priceBookEntryNumber": "<priceBookEntryNumber>",
        "listPrice": "19.99",
        "fromQuantity": "19.99",
        "toQuantity": "19.99",
        "priceModel": "<priceModel>",
        "rateCardEntry": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "billableComponentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "unitOfMeasure": "<unitOfMeasure>",
          "description": "<description>",
          "usageType": "<usageType>",
          "billableUnitOfMeasure": "<billableUnitOfMeasure>",
          "conversion": "19.99",
          "invoiceFrequency": "<invoiceFrequency>",
          "priceModel": "<priceModel>"
        },
        "externalIdentifiers": [
          {
            "fieldName": "<fieldName>",
            "value": "<value>",
            "externalUrl": "<externalUrl>"
          }
        ]
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
INVALID_ID 400
NOT_FOUND 400

Statuses