Retrieve a Variant

GET

/v1/variants/:id

Retrieves the variant with the given ID.


curl "https://api.lemonsqueezy.com/v1/variants/1" \
  -H 'Accept: application/vnd.api+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {api_key}' 

Returns

Returns a Variant object.

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/variants/1"
  },
  "data": {
    "type": "variants",
    "id": "1",
    "attributes": {
      "product_id": 1,
      "name": "Citrus Burst Lemonade",
      "slug": "46beb127-a8a9-33e6-89b5-078505657239",
      "description": "<p>Lorem ipsum...</p>",
      "links": [],
      "price": 999,
      "is_subscription": false,
      "interval": null,
      "interval_count": null,
      "has_free_trial": false,
      "trial_interval": "day",
      "trial_interval_count": 30,
      "pay_what_you_want": false,
      "min_price": 0,
      "suggested_price": 0,
      "has_license_keys": false,
      "license_activation_limit": 5,
      "is_license_limit_unlimited": false,
      "license_length_value": 1,
      "license_length_unit": "years",
      "is_license_length_unlimited": false,
      "sort": 1,
      "status": "published",
      "status_formatted": "Published",
      "created_at": "2024-05-24T14:15:06.000000Z",
      "updated_at": "2024-06-24T14:44:38.000000Z",
      "test_mode": false
    },
    "relationships": {
      "product": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/variants/1/product",
          "self": "https://api.lemonsqueezy.com/v1/variants/1/relationships/product"
        }
      },
      "files": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/variants/1/files",
          "self": "https://api.lemonsqueezy.com/v1/variants/1/relationships/files"
        }
      },
      "price-model": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/variants/1/price-model",
          "self": "https://api.lemonsqueezy.com/v1/variants/1/relationships/price-model"
        }
      }
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/variants/1"
    }
  }
}

Was this page helpful?