Retrieve a Store

GET

/v1/stores/:id

Retrieves the store with the given ID.


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

Returns

Returns a Store object.

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/stores/1"
  },
  "data": {
    "type": "stores",
    "id": "1",
    "attributes": {
      "name": "My Store",
      "slug": "my-store",
      "domain": "my-store.lemonsqueezy.com",
      "url": "https://my-store.lemonsqueezy.com",
      "avatar_url": "https://app.lemonsqueezy.com/storage/avatars/stores/1/czTkMkDm4Vfb8PZehb5c29XFCm9JZyJx0AjEZP7s.png",
      "plan": "fresh",
      "country": "US",
      "country_nicename": "United States",
      "currency": "USD",
      "total_sales": 1,
      "total_revenue": 999,
      "thirty_day_sales": 0,
      "thirty_day_revenue": 0,
      "created_at": "2021-05-24T14:15:06.000000Z",
      "updated_at": "2021-06-15T10:03:14.000000Z"
    },
    "relationships": {
      "products": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/stores/1/products",
          "self": "https://api.lemonsqueezy.com/v1/stores/1/relationships/products"
        }
      },
      "orders": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/stores/1/orders",
          "self": "https://api.lemonsqueezy.com/v1/stores/1/relationships/orders"
        }
      },
      "subscriptions": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/stores/1/subscriptions",
          "self": "https://api.lemonsqueezy.com/v1/stores/1/relationships/subscriptions"
        }
      },
      "discounts": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/stores/1/discounts",
          "self": "https://api.lemonsqueezy.com/v1/stores/1/relationships/discounts"
        }
      },
      "license-keys": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/stores/1/license-keys",
          "self": "https://api.lemonsqueezy.com/v1/stores/1/relationships/license-keys"
        }
      },
      "webhooks": {
        "links": {
          "related": "https://api.lemonsqueezy.com/v1/stores/1/webhooks",
          "self": "https://api.lemonsqueezy.com/v1/stores/1/relationships/webhooks"
        }
      }
    },
    "links": {
      "self": "https://api.lemonsqueezy.com/v1/stores/1"
    }
  }
}

Was this page helpful?