Costs

Query costsheets

Changed on

Use when listing or searching costsheets (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.

post/costs/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/costs/search
  • Auth
    API key in header x-api-key

Request body

costsheetIDsstring[]

CostsheetIDs allows filtering by specific costsheet IDs

environmentIDstring

EnvironmentID filters by specific environment ID

lookupKeystring

LookupKey filters by lookup key

namestring

Name filters by costsheet name

status'published' | 'deleted' | 'archived'
tenantIDstring

TenantID filters by specific tenant ID

Response

Paginated costsheets

Changes

  • e1d4e27b5677Revision changes
    • info

      added the optional property //// to the response with the status

  • 9cd0dab91f5cRevision changes
    • info

      added the optional property ///// to the response with the status