GET
/v1/product-variants/{id}/lowestRetrieves the cheapest total monthly payment (monthly payment + insurance) across all available lease terms for a product variant. The identifier can be either the variant's public ID (pub_id) or external_id. Returns the lowest price, the corresponding lease term in months, and the product variant ID. Requires ProductVariantRead permission on the variant's product organization.
Parameters
Request parameters for this endpoint
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | Required | Product variant identifier - can be public ID (pub_id) or external_id |
Response Data
Fields returned in the response
| Name | Type | Required | Description |
|---|---|---|---|
price | number (double) | Required | Lowest total monthly payment (monthly payment + insurance) across all lease terms |
productVariantId | ProductVariantPubId | Required | Public ID of the product variant |
term | integer (int32) | Required | Lease term in months that offers the lowest price |
GET
/v1/product-variants/{id}/lowestRequest
curl https://api.thesweetspot.com/v1/product-variants/id_123/lowest \
-H "Content-Type: application/json"Response
{
"price": 0,
"productVariantId": "string",
"term": 0
}