Home

Types

• LemonSqueezy
• LemonSqueezyError: The error types relating to Lemon Squeezy instances and methods.
• LemonSqueezyAPIDataAndIncluded
• LemonSqueezyAPIDataIncludedAndMeta
• Meta: An object containing pagination information for paginated requests
• Meta.Page
• LemonSqueezyAPIError: An error returned from Lemon Squeezy API
• ErrorDetail
• Checkout
• Checkout.APIResponse
• Checkout.Attributes: An object representing the resources data.
• Checkout.ProductOptions
• Checkout.CheckoutOptions
• Checkout.CheckoutData
• Checkout.CheckoutData.BillingAddress
• Checkout.Included: Related resources that can be included in the same response by using the include query parameter.
• Customer
• Customer.APIResponse
• Customer.Attributes: An object representing the resources data.
• Customer.Included: Related resources that can be included in the same response by using the include query parameter.
• Discount
• Discount.APIResponse
• Discount.Attributes: An object representing the resources data.
• Discount.Included: Related resources that can be included in the same response by using the include query parameter.
• DiscountRedemption
• DiscountRedemption.APIResponse
• DiscountRedemption.Attributes: An object representing the resources data.
• DiscountRedemption.Included: Related resources that can be included in the same response by using the include query parameter.
• File
• File.APIResponse
• File.Attributes: An object representing the resources data.
• File.Included: Related resources that can be included in the same response by using the include query parameter.
• ActivateLicense
• ActivateLicense.LicenseKey
• ActivateLicense.Instance
• ActivateLicense.Meta
• ValidateLicense
• ValidateLicense.LicenseKey
• ValidateLicense.Instance
• ValidateLicense.Meta
• DeactivateLicense
• DeactivateLicense.LicenseKey
• DeactivateLicense.Meta
• LicenseKey
• LicenseKey.APIResponse
• LicenseKey.Attributes: An object representing the resources data.
• LicenseKey.Included: Related resources that can be included in the same response by using the include query parameter.
• LicenseKeyInstance
• LicenseKeyInstance.APIResponse
• LicenseKeyInstance.Attributes: An object representing the resources data.
• LicenseKeyInstance.Included: Related resources that can be included in the same response by using the include query parameter.
• Order: In Lemon Squeezy, an order is created when a customer purchases a product.
• Order.APIResponse
• Order.Attributes: An object representing the resources data.
• Order.FirstOrderItem: An object containing first order item from the order.
• Order.Included: Related resources that can be included in the same response by using the include query parameter.
• OrderItem: In Lemon Squeezy, an order item represents a line item for an order that includes product, variant and price information. See documentation
• OrderItem.APIResponse
• OrderItem.Attributes: An object representing the resources data.
• OrderItem.Included: Related resources that can be included in the same response by using the include query parameter.
• Product: In Lemon Squeezy, products describe the digital goods you offer to your customers.
• Product.APIResponse
• Product.Attributes: An object representing the resources data.
• Product.Included: Related resources that can be included in the same response by using the include query parameter.
• Store: Everything in Lemon Squeezy belongs to a store. Each store can have multiple products, orders, discounts etc. and is billed separately. You can create a new store via the Lemon Squeezy Dashboard.
• Store.APIResponse
• Store.Attributes: An object representing the resources data.
• Store.Included: Related resources that can be included in the same response by using the include query parameter.
• Subscription
• Subscription.APIResponse
• Subscription.Attributes: An object representing the resources data.
• Subscription.Pause
• Subscription.Urls
• Subscription.Included: Related resources that can be included in the same response by using the include query parameter.
• User
• User.APIResponse
• User.Attributes: An object representing the resources data.
• User.Included: Related resources that can be included in the same response by using the include query parameter.
• Variant: In Lemon Squeezy, a product can have one or more variants. A variant represents a different option that is presented to the customer at checkout and has its own unique set of pricing options, files and license key settings.
• Variant.APIResponse
• Variant.Attributes: An object representing the resources data.
• Variant.Included: Related resources that can be included in the same response by using the include query parameter.

Global Functions

• getCheckout(_:​queryItems:​): Get a single checkout by ID.
• createCheckout(body:​): Create a checkout.
• getCheckouts(pageNumber:​pageSize:​queryItems:​): Returns a list of checkouts.
• getCustomer(_:​queryItems:​): Get a single customer by ID.
• getCustomers(pageNumber:​pageSize:​queryItems:​): Returns a list of customers.
• getDiscount(_:​queryItems:​): Get a single discount by ID.
• getDiscounts(pageNumber:​pageSize:​queryItems:​): Returns a list of discounts.
• getDiscountRedemption(_:​queryItems:​): Get a single discount redemption by ID.
• getDiscountRedemptions(pageNumber:​pageSize:​queryItems:​): Returns a list of discounts redemptions.
• getFile(_:​queryItems:​): Get a single file by ID.
• getFiles(pageNumber:​pageSize:​queryItems:​): Returns a list of files.
• activateLicense(licenseKey:​instanceName:​)
• validateLicense(licenseKey:​instanceId:​)
• deactivateLicense(licenseKey:​instanceId:​)
• getLicenseKey(_:​queryItems:​): Get a single license key by ID.
• getLicenseKeys(pageNumber:​pageSize:​queryItems:​): Returns a list of license keys.
• getLicenseKeyInstance(_:​queryItems:​): Get a single license key instance by ID.
• getLicenseKeyInstances(pageNumber:​pageSize:​queryItems:​): Returns a list of license key instances.
• getOrder(_:​queryItems:​): Get a single order by ID.
• getOrders(pageNumber:​pageSize:​queryItems:​): Returns a list of orders.
• getOrderItem(_:​queryItems:​): Get a single order item by ID.
• getOrderItems(pageNumber:​pageSize:​queryItems:​): Returns a list of order items.
• getProduct(_:​queryItems:​): Get a single product by ID.
• getProducts(pageNumber:​pageSize:​queryItems:​): Returns a list of products.
• getStores(pageNumber:​pageSize:​queryItems:​): Returns a list of stores.
• getStore(_:​queryItems:​): Return a single store. Equivalent to GET /v1/stores/:id
• getSubscription(_:​queryItems:​): Get a single subscription by ID.
• updateSubscription(_:​body:​)
• cancelSubscription(_:​)
• getSubscriptions(pageNumber:​pageSize:​queryItems:​): Returns a list of subscriptions.
• getMe(): Return information about the currently-authenticated user.
• getVariant(_:​queryItems:​): Get a single variant by ID.
• getVariants(pageNumber:​pageSize:​queryItems:​): Returns a list of variants.