Skip to main content

List Custom-price Links

List a product's custom-price links, newest first, including archived ones. Filter by status to narrow the list. The envelope is { items, pagination }.

Default per_page is 25. A page past the last page returns empty items and the requested current_page.

Request​

GET /products/{productId}/custom-price-links

Path Parameters​

ParameterTypeRequiredDescription
productIdstringYesProduct UUID.

Query Parameters​

ParameterTypeRequiredDefaultDescription
pageintegerNo1Page number.
per_pageintegerNo25Items per page (min 1, max 100).
statusstringNo—One of active, used_up, expired, archived. See Status.

Example Request​

curl -X GET "https://cart.easy.tools/api/v1/products/0632bef5-c308-42cd-9cba-89a7a4f722bb/custom-price-links" \
-H "Authorization: Bearer YOUR_API_TOKEN"
curl -X GET "https://cart.easy.tools/api/v1/products/0632bef5-c308-42cd-9cba-89a7a4f722bb/custom-price-links?status=used_up" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response​

Success Response (200)​

{
"items": [
{
"id": "3f9c2b7e-8d41-4a6f-b2e5-7c1d9a0e4f63",
"product_id": "0632bef5-c308-42cd-9cba-89a7a4f722bb",
"variant_id": "d91c65aa-b221-4aa4-b626-cf0d8a198749",
"amount": 1499,
"currency": "usd",
"is_net": false,
"max_purchases": 20,
"purchases_count": 7,
"expires_at": "2027-01-01T05:59:00+01:00",
"archived_at": null,
"status": "active",
"checkout_url": "https://cart.easy.tools/checkout/mystore/premium-coffee?_sig=amount%2Cplan%2Cprice_link&amount=1499&plan=price_123&price_link=3f9c2b7e-8d41-4a6f-b2e5-7c1d9a0e4f63&signature=4b8f0c2e9d7a6153e1f04b9c8a2d7e6f5c3b1a0d9e8f7c6b5a4d3e2f1c0b9a8e",
"created_at": "2026-11-18T15:20:41+01:00"
},
{
"id": "a81e5d20-6c37-4f9b-9e12-5b4d8f2c7a90",
"product_id": "0632bef5-c308-42cd-9cba-89a7a4f722bb",
"variant_id": null,
"amount": 999,
"currency": "usd",
"is_net": false,
"max_purchases": 5,
"purchases_count": 5,
"expires_at": null,
"archived_at": null,
"status": "used_up",
"checkout_url": "https://cart.easy.tools/checkout/mystore/premium-coffee?_sig=amount%2Cprice_link&amount=999&price_link=a81e5d20-6c37-4f9b-9e12-5b4d8f2c7a90&signature=9e2d4c6b8a0f1e3d5c7b9a2e4f6d8c0b1a3e5f7d9c2b4a6e8f0d1c3b5a7e9f2d",
"created_at": "2026-11-02T10:04:12+01:00"
}
],
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 25,
"total": 2
}
}

See Custom-price Link Object.

Pagination Object​

FieldTypeDescription
current_pageintegerRequested page.
total_pagesintegerTotal pages (at least 1).
per_pageintegerPage size.
totalintegerTotal links matching the filter.

Error Responses​

Bad Request (400)​

Returned when productId is not a UUID, or status or per_page is not a valid value.

{
"message": "Invalid value for 'status': 'paused'"
}

Not Found Error (404)​

{
"message": "Product with ID 0632bef5-c308-42cd-9cba-89a7a4f722bb not found"
}

Validation Error (422 Unprocessable Entity)​

Returned for a test-mode product — see Test-mode products.

{
"message": "Product \"0632bef5-c308-42cd-9cba-89a7a4f722bb\" is a test-mode product; custom-price links for test-mode products are managed in the dashboard"
}

Unauthorized Error (401)​

{
"message": "Unauthenticated."
}

Forbidden Error (403)​

{
"message": "You do not have API access to the requested store."
}