Skip to main content
It stores pricing information.
Field NameData TypeDescriptionNested Fields
_idstringUnique identifier for each document within collection0
price_idstringUnique identifier for price0
pricebookobjectPrice information for pricebook2
pricebook.idstringUnique identifier for id0
pricebook.namestringName of specific pricebook.0
variant_idstringUnique identifier for variant0
business_entity_idstringUnique identifier for business entity0
statusstringCurrent status of specific item/variant price.0
price_typestringPrice information for price type0
currencystringField for currency0
amountintegerField for amount0
priorityintegerField for priority0
customer_segmentsarray_of_objectsField for customer segments2
customer_segments.idstringUnique identifier for id0
customer_segments.namestringType of customer.0
min_quantityintegerQuantity of min0
max_quantityintegerQuantity of max0
start_datedatetimeTimestamp for when start date was created/updated0
end_datestringTimestamp for when end date was created/updated0
created_atstringTimestamp when the record was created0
updated_atstringTimestamp when the record was updated0


{
    "_id": {
        "$oid": "6862c2639585c9209dcf3ed5"
    },
    "price_id": "81b1b3a3-b3da-4350-90db-28ac54ee3008",
    "pricebook": {
        "id": "70d2b9c5-cc20-4450-9d63-c485f9745418",
        "name": "Default Prices - USA 2025"
    },
    "variant_id": "b57f10f1-3200-480c-95be-59d90309df47",
    "business_entity_id": "7e820970-ce75-4ddd-94a7-f2ddaf9e5ad4",
    "status": "active",
    "price_type": "regular",
    "currency": "USD",
    "amount": 109,
    "priority": 50,
    "customer_segments": [
        {
            "id": "a72df63f-4740-4c34-a154-765aba553fd7",
            "name": "Retail Customers"
        }
    ],
    "min_quantity": 1,
    "max_quantity": 10,
    "start_date": "2025-01-01T00:00:00Z",
    "end_date": null,
    "created_at": {
        "$date": "2025-01-01T10:05:00Z"
    },
    "updated_at": {
        "$date": "2025-07-29T12:27:24.050Z"
    }
}