API referencePricing and sell-through
List culture line prices
Each priced culture line's current list and wholesale price and its pricing tier, newest first by when the line was first priced. Filter to one culture line with plant_id, or to one tier with pricing_tier.
GET
https://app.xplantpro.com/Scope
read:pricingEvery amount is exact decimal text with its currency. Never add amounts in different currencies.
Needs culture line pricing in the workspace's plan; without it the answer is FEATURE_NOT_INCLUDED.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
plant_id | string (uuid) | No | Only this culture line's price. A culture line is identified by its plant id. |
pricing_tier | string | No | Only culture lines in this pricing tier, spelled exactly as your lab names it. 1–40 characters. |
limit | integer | No | Page size. Values above 200 are capped at 200. Default 50. From 1 to 200. |
offset | integer | No | Number of records to skip. Prefer cursor where a list offers it: an offset shifts when records are added ahead of it. Default 0. At least 0. |
cursor | string | No | Continue from the previous page: pass its meta.next_cursor unchanged, with the same filters. Treat it as opaque. Not combinable with offset. Up to 2048 characters. |
Example
curl "https://app.xplantpro.com/api/v1/pricing/culture-lines?plant_id=0b8e2f4c-6a1d-4c3e-9f7a-2d5b8c1e4a90" \
-H "Authorization: Bearer $XPLANT_API_KEY"Response
200 with { "ok": true, "data": … }. data is an array. To get the next page, pass meta.next_cursor back as cursor; it is null on the last page. See Pagination.
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | — |
plant_id | string (uuid) | Yes | The culture line this price is for (a plant id). |
list_price | object | Yes | — |
list_price.amount | string | Yes | An exact decimal, as text — for example "1250.00". Never a floating-point number; parse it with a decimal type. |
list_price.currency | string | null | Yes | ISO 4217 currency code, for example USD. Null only when the record carries no currency. Never add amounts in different currencies. |
wholesale_price | object | null | Yes | — |
previous_list_price | object | null | Yes | The list price before the latest change, in the currency it was set in. Null until the price has changed once. |
pricing_tier | string | null | Yes | The line's pricing tier, as your lab names its tiers. |
tier_score | string | null | Yes | The score the tier was derived from, as exact decimal text. Not money. |
price_source | string | Yes | Who set the list price: manual, store_adopted, store_follow. manual is a person typing it, store_adopted a person accepting the price from your store, and store_follow an automatic update that follows your store's price. |
price_source_at | string | null | Yes | When the list price was last set that way, as an ISO 8601 timestamp. |
notes | string | null | Yes | — |
created_at | string | null | Yes | When the culture line was first priced. |
updated_at | string | null | Yes | — |
{
"ok": true,
"data": [
{
"id": "a4c8e2f6-1b3d-4f5a-9c7e-2d4b6f8a0c12",
"plant_id": "6d1b3f8a-4c2e-4a97-b5d0-8e7f2a1c9b43",
"list_price": {
"amount": "18.50",
"currency": "USD"
},
"wholesale_price": {
"amount": "11.00",
"currency": "USD"
},
"previous_list_price": {
"amount": "16.00",
"currency": "USD"
},
"pricing_tier": "B",
"tier_score": "72.500",
"price_source": "manual",
"price_source_at": "2026-09-10T09:12:00.000Z",
"notes": null,
"created_at": "2026-02-03T11:40:22.000Z",
"updated_at": "2026-09-10T09:12:00.000Z"
}
]
}The envelope can also carry meta:
| Field | Type | Required | Description |
|---|---|---|---|
next_cursor | string | null | Yes | Pass as cursor to fetch the next page. null means this is the last page. |
| Response header | Meaning |
|---|---|
X-Request-Id | Identifies this request. Include it when you contact support. |
Errors
| Status | Code | When |
|---|---|---|
401 | UNAUTHORIZED | The key is missing, malformed or revoked, or its owner is no longer a member of the workspace. |
402 | PAID_PLAN_REQUIRED | The workspace's plan does not include the API. The full API is included with xPlant+ Teams and Enterprise; on Hobby and Pro Lab, keys can connect devices only. |
402 | FEATURE_NOT_INCLUDED | Culture line pricing is not included in your plan. |
403 | FORBIDDEN | The key lacks a scope this operation requires, or its owner's current role in the workspace cannot use it — a key never does more than its owner can in xPlant. error names the scope, and for a role, the role it needs. |
403 | DEVICE_TOKEN_NOT_ACCEPTED | A device token was sent; this operation needs a workspace API key. |
404 | NOT_FOUND | plant_id names no culture line in the key's workspace. |
422 | VALIDATION_ERROR | Both cursor and offset were sent; use one. |
422 | INVALID_CURSOR | The cursor is malformed, or came from a different list or different filters. Start again without it. |
422 | VALIDATION_ERROR | A query parameter is malformed. error names it. |
429 | RATE_LIMIT_EXCEEDED | Too many requests for this key, device token or workspace. Wait Retry-After seconds. |
500 | FEATURE_CHECK_FAILED | Your plan could not be checked. Retry later. |
500 | CULTURE_LINE_PRICE_QUERY_FAILED | The prices could not be read. Retry later. |
Branch on code, never on the error text. See Errors.
Get sell-through
Units sold and revenue per culture line over a period, highest units first. Filter with from and to for the period and plant_id for one culture line.
List price changes
Every change to a culture line's price, newest first: what it moved from, what it moved to, when, who or what moved it. Filter with plant_id for one culture line and from and to for a period.