Skip to main content
POST
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Body

application/json
apiKey
string
required

Your Lemon Squeezy API key. Used for this import only. It is never returned in a response or included in the report email.

storeId
string
required

The Lemon Squeezy store to import, as a string of digits. A key can reach several stores; one store is imported per request.

Pattern: ^[0-9]+$
Example:

"12345"

reportEmail
string<email>

Where the summary email is sent. Defaults to the organization owner's email.

dryRun
boolean
default:false

Run the whole import and save nothing. The report email shows what a real run would do.

orderType
enum<string>
default:all

Which sales to import. all imports every order and every subscription renewal. one_time imports only orders that did not start a subscription. subscription imports only orders that started a subscription, plus their renewals. License keys follow their orders. Products, plans, customers, files and discounts are imported whichever value is sent.

Available options:
all,
one_time,
subscription
only
enum<string>[]

Run only these steps. Defaults to every step.

Available options:
store,
products,
customers,
files,
orders,
renewals,
discounts,
licenses
skip
enum<string>[]

Leave these steps out.

Available options:
store,
products,
customers,
files,
orders,
renewals,
discounts,
licenses
publishPlan
boolean
default:true

Publish each imported plan so it can be sold straight away, including a plan an earlier import left as a draft. When false, plans arrive as drafts to review and publish.

publishDiscount
boolean
default:true

Make each imported discount code usable at checkout, including a code an earlier import left switched off. A code limited to plans that are not published stays off. When false, codes arrive switched off.

overwriteProfile
boolean
default:false

Overwrite the organization name and business profile fields that are already filled in. When false, only blank fields are filled.

skipAnalytics
boolean
default:false

Do not add the imported sales to revenue analytics.

Response

The import is queued. Nothing has been imported yet.

status
enum<string>

Always queued. Nothing has been imported yet.

Available options:
queued
taskId
string<uuid>

A reference for support. It cannot be used to query progress.

storeId
string
storeName
string | null

The store's name from Lemon Squeezy. null if Lemon Squeezy could not be reached during the check; the import is still queued.

steps
enum<string>[]

The steps that will run, after only and skip are applied.

Available options:
store,
products,
customers,
files,
orders,
renewals,
discounts,
licenses
orderType
enum<string>
Available options:
all,
one_time,
subscription
dryRun
boolean
reportEmail
string<email>

The address the summary will be sent to.