🦙
lemonsqueezy.ts
⌘K
Readme
Learn
API
/
lemonsqueezy.ts
26
Classes
LemonsqueezyClient
Functions
createCheckout
getUser
listAllCheckouts
listAllDiscounts
listAllFiles
listAllLicenseKeyInstances
listAllLicenseKeys
listAllOrderItems
listAllOrders
listAllProducts
listAllStores
listAllSubscriptions
listAllVariants
retrieveCheckout
retrieveDiscount
retrieveFile
retrieveLicenseKey
retrieveLicenseKeyInstance
retrieveOrder
retrieveOrderItem
retrieveProduct
retrieveStore
retrieveSubscription
retrieveVariant
updateSubscription
lemonsqueezy.ts/checkout
15
Default Export
default
Functions
createCheckout
listAllCheckouts
retrieveCheckout
Type Aliases
CreateCheckoutResult
ListAllCheckoutsResult
RetrieveCheckoutResult
Interfaces
CreateCheckoutOptions
LemonsqueezyBillingAddress
LemonsqueezyCheckout
LemonsqueezyCheckoutData
LemonsqueezyCheckoutOptions
LemonsqueezyCheckoutPreview
LemonsqueezyProductOptions
ListAllCheckoutsOptions
RetrieveCheckoutOptions
lemonsqueezy.ts/client
1
Classes
LemonsqueezyClient
lemonsqueezy.ts/discount
7
Default Export
default
Functions
listAllDiscounts
retrieveDiscount
Type Aliases
ListAllDiscountsResult
RetrieveDiscountResult
Interfaces
LemonsqueezyDiscount
ListAllDiscountsOptions
RetrieveDiscountOptions
lemonsqueezy.ts/file
7
Default Export
default
Functions
listAllFiles
retrieveFile
Type Aliases
ListAllFilesResult
RetrieveFileResult
Interfaces
LemonsqueezyFile
ListAllFilesOptions
RetrieveFileOptions
lemonsqueezy.ts/licenseKey
7
Default Export
default
Functions
listAllLicenseKeys
retrieveLicenseKey
Type Aliases
ListAllLicenseKeysResult
RetrieveLicenseKeyResult
Interfaces
LemonsqueezyLicenseKey
ListAllLicenseKeysOptions
RetrieveLicenseKeyOptions
lemonsqueezy.ts/licenseKeyInstance
7
Default Export
default
Functions
listAllLicenseKeyInstances
retrieveLicenseKeyInstance
Type Aliases
ListAllLicenseKeyInstancesResult
RetrieveLicenseKeyInstanceResult
Interfaces
LemonsqueezyLicenseKeyInstance
ListAllLicenseKeyInstancesOptions
RetrieveLicenseKeyInstanceOptions
lemonsqueezy.ts/modules
100
Functions
createCheckout
getUser
listAllCheckouts
listAllDiscounts
listAllFiles
listAllLicenseKeyInstances
listAllLicenseKeys
listAllOrderItems
listAllOrders
listAllProducts
listAllStores
listAllSubscriptionInvoices
listAllSubscriptions
listAllVariants
retrieveCheckout
retrieveDiscount
retrieveFile
retrieveLicenseKey
retrieveLicenseKeyInstance
retrieveOrder
retrieveOrderItem
retrieveProduct
retrieveStore
retrieveSubscription
retrieveSubscriptionInvoice
retrieveVariant
updateSubscription
Type Aliases
CreateCheckoutResult
GetUserResult
LemonsqueezyInterval
ListAllCheckoutsResult
ListAllDiscountsResult
ListAllFilesResult
ListAllLicenseKeyInstancesResult
ListAllLicenseKeysResult
ListAllOrderItemsResult
ListAllOrdersResult
ListAllProductsResult
ListAllStoresResult
ListAllSubscriptionInvoicesResult
ListAllSubscriptionsResult
ListAllVariantsResult
RetrieveCheckoutResult
RetrieveDiscountResult
RetrieveFileResult
RetrieveLicenseKeyInstanceResult
RetrieveLicenseKeyResult
RetrieveOrderItemResult
RetrieveOrderResult
RetrieveProductResult
RetrieveStoreResult
RetrieveSubscriptionInvoiceResult
RetrieveSubscriptionResult
RetrieveVariantResult
UpdateSubscriptionResult
Interfaces
CreateCheckoutOptions
GetUserOptions
LemonsqueezyBillingAddress
LemonsqueezyCheckout
LemonsqueezyCheckoutData
LemonsqueezyCheckoutOptions
LemonsqueezyCheckoutPreview
LemonsqueezyDiscount
LemonsqueezyFile
LemonsqueezyLicenseKey
LemonsqueezyLicenseKeyInstance
LemonsqueezyOrder
LemonsqueezyOrderItem
LemonsqueezyProduct
LemonsqueezyProductOptions
LemonsqueezyStore
LemonsqueezySubscription
LemonsqueezySubscriptionInvoice
LemonsqueezyUser
LemonsqueezyVariant
ListAllCheckoutsOptions
ListAllDiscountsOptions
ListAllFilesOptions
ListAllLicenseKeyInstancesOptions
ListAllLicenseKeysOptions
ListAllOrderItemsOptions
ListAllOrdersOptions
ListAllProductsOptions
ListAllStoresOptions
ListAllSubscriptionInvoicesOptions
ListAllSubscriptionsOptions
ListAllVariantsOptions
RetrieveCheckoutOptions
RetrieveDiscountOptions
RetrieveFileOptions
RetrieveLicenseKeyInstanceOptions
RetrieveLicenseKeyOptions
RetrieveOrderItemOptions
RetrieveOrderOptions
RetrieveProductOptions
RetrieveStoreOptions
RetrieveSubscriptionInvoiceOptions
RetrieveSubscriptionOptions
RetrieveVariantOptions
UpdateSubscriptionOptions
lemonsqueezy.ts/order
7
Default Export
default
Functions
listAllOrders
retrieveOrder
Type Aliases
ListAllOrdersResult
RetrieveOrderResult
Interfaces
LemonsqueezyOrder
ListAllOrdersOptions
RetrieveOrderOptions
lemonsqueezy.ts/orderItem
7
Default Export
default
Functions
listAllOrderItems
retrieveOrderItem
Type Aliases
ListAllOrderItemsResult
RetrieveOrderItemResult
Interfaces
LemonsqueezyOrderItem
ListAllOrderItemsOptions
RetrieveOrderItemOptions
lemonsqueezy.ts/product
7
Default Export
default
Functions
listAllProducts
retrieveProduct
Type Aliases
ListAllProductsResult
RetrieveProductResult
Interfaces
LemonsqueezyProduct
ListAllProductsOptions
RetrieveProductOptions
lemonsqueezy.ts/store
7
Default Export
default
Functions
listAllStores
retrieveStore
Type Aliases
ListAllStoresResult
RetrieveStoreResult
Interfaces
LemonsqueezyStore
ListAllStoresOptions
RetrieveStoreOptions
lemonsqueezy.ts/subscription
10
Default Export
default
Functions
listAllSubscriptions
retrieveSubscription
updateSubscription
Type Aliases
ListAllSubscriptionsResult
RetrieveSubscriptionResult
UpdateSubscriptionResult
Interfaces
LemonsqueezySubscription
ListAllSubscriptionsOptions
RetrieveSubscriptionOptions
UpdateSubscriptionOptions
lemonsqueezy.ts/subscriptionInvoice
7
Default Export
default
Functions
listAllSubscriptionInvoices
retrieveSubscriptionInvoice
Type Aliases
ListAllSubscriptionInvoicesResult
RetrieveSubscriptionInvoiceResult
Interfaces
LemonsqueezySubscriptionInvoice
ListAllSubscriptionInvoicesOptions
RetrieveSubscriptionInvoiceOptions
lemonsqueezy.ts/types
67
Type Aliases
CreateCheckoutResult
GetUserResult
LemonsqueezyInterval
ListAllCheckoutsResult
ListAllDiscountsResult
ListAllFilesResult
ListAllLicenseKeyInstancesResult
ListAllLicenseKeysResult
ListAllOrderItemsResult
ListAllOrdersResult
ListAllProductsResult
ListAllStoresResult
ListAllSubscriptionsResult
ListAllVariantsResult
RetrieveCheckoutResult
RetrieveDiscountResult
RetrieveFileResult
RetrieveLicenseKeyInstanceResult
RetrieveLicenseKeyResult
RetrieveOrderItemResult
RetrieveOrderResult
RetrieveProductResult
RetrieveStoreResult
RetrieveSubscriptionResult
RetrieveVariantResult
UpdateSubscriptionResult
Interfaces
CreateCheckoutOptions
GetUserOptions
LemonsqueezyBillingAddress
LemonsqueezyCheckout
LemonsqueezyCheckoutData
LemonsqueezyCheckoutOptions
LemonsqueezyDiscount
LemonsqueezyFile
LemonsqueezyLicenseKey
LemonsqueezyLicenseKeyInstance
LemonsqueezyOrder
LemonsqueezyOrderItem
LemonsqueezyProduct
LemonsqueezyProductOptions
LemonsqueezyStore
LemonsqueezySubscription
LemonsqueezyUser
LemonsqueezyVariant
ListAllCheckoutsOptions
ListAllDiscountsOptions
ListAllFilesOptions
ListAllLicenseKeyInstancesOptions
ListAllLicenseKeysOptions
ListAllOrderItemsOptions
ListAllOrdersOptions
ListAllProductsOptions
ListAllStoresOptions
ListAllSubscriptionsOptions
ListAllVariantsOptions
RetrieveCheckoutOptions
RetrieveDiscountOptions
RetrieveFileOptions
RetrieveLicenseKeyInstanceOptions
RetrieveLicenseKeyOptions
RetrieveOrderItemOptions
RetrieveOrderOptions
RetrieveProductOptions
RetrieveStoreOptions
RetrieveSubscriptionOptions
RetrieveVariantOptions
UpdateSubscriptionOptions
lemonsqueezy.ts/user
4
Default Export
default
Functions
getUser
Type Aliases
GetUserResult
Interfaces
GetUserOptions
LemonsqueezyUser
lemonsqueezy.ts/variant
8
Default Export
default
Functions
listAllVariants
retrieveVariant
Type Aliases
LemonsqueezyInterval
ListAllVariantsResult
RetrieveVariantResult
Interfaces
LemonsqueezyVariant
ListAllVariantsOptions
RetrieveVariantOptions
lemonsqueezy.ts