Licenses

3 endpoints. Each needs an API key or OAuth token with the scope shown; the key already names its store, so paths start at /v1/store. Generated from the live contract; also in openapi.json.

Sold keys with their state, devices and expiry. `q` matches an exact key, an email, an order number or a key id

GET/v1/store/licenses

Or name the store: GET /v1/stores/{storeId}/licenses

catalog:readrole: catalog:readlistLicenses

Parameters

qstring | nullquery
filter"all" | "active" | "expiring" | "expired" | "not_started" | "revoked" | "suspended"query
productIdprd_… | nullquery
cursorstring | nullquery
limitinteger | stringquery
sort"sold" | "product" | "buyer" | "state" | "left" | "devices" | "seen"query
dir"asc" | "desc"query

Response LicenseList

itemsLicenseRow[]required
countsobjectrequired
nextCursorstringrequired
exactKeybooleanrequired

Example

curl "https://api.shopfa.st/v1/store/licenses" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY"

const res = await fetch('https://api.shopfa.st/v1/store/licenses', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
  },
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();

import os, requests

res = requests.request(
    "GET",
    "https://api.shopfa.st/v1/store/licenses",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
)
res.raise_for_status()
data = res.json()

req, _ := http.NewRequest("GET", "https://api.shopfa.st/v1/store/licenses", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)

Try it with your key

API base URLAPI key or token

qfilterproductIdcursorlimitsortdir

Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

One key: devices, history and limits

GET/v1/store/licenses/{licenseId}

Or name the store: GET /v1/stores/{storeId}/licenses/{licenseId}

catalog:readrole: catalog:readgetLicense

Parameters

licenseIdkey_…pathrequired

Response LicenseDetail

idLicenseKeyIdrequired
productIdProductIdrequired
productNamestringrequired
planLicensePlanOutrequired
keyMaskedstringrequired
orderIdOrderId | nullrequired
orderNumberstringrequired
buyerEmailstringrequired
stateLicenseStaterequired
clockLicenseClockrequired

16 more fields

startedAtTimestamp | nullrequired
expiresAtTimestamp | nullrequired
activatedAtTimestamp | nullrequired
devicesUsedintegerrequired
maxDevicesinteger | nullrequired
validationsintegerrequired
lastValidatedAtTimestamp | nullrequired
assignedAtTimestamp | nullrequired
productPausedbooleanrequired
extraSecondsintegerrequired
revokedReasonstringrequired
maxDevicesOverrideinteger | nullrequired
devicesLicenseDevice[]required
eventsLicenseEvent[]required
checkoutSessionIdCheckoutSessionId | nullrequired
buyerResetsobjectrequired
- used30dintegerrequired
- per30dintegerrequired

Example

curl "https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY"

const res = await fetch('https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
  },
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();

import os, requests

res = requests.request(
    "GET",
    "https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
)
res.raise_for_status()
data = res.json()

req, _ := http.NewRequest("GET", "https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)

Try it with your key

API base URLAPI key or token

licenseId

Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

Revoke, restore, suspend, resume, add time, start the clock, release or reset devices, or change the device limit

POST/v1/store/licenses/{licenseId}/actions

Or name the store: POST /v1/stores/{storeId}/licenses/{licenseId}/actions

catalog:writerole: catalog:writelicenseAction

Parameters

licenseIdkey_…pathrequired

Response LicenseDetail

idLicenseKeyIdrequired
productIdProductIdrequired
productNamestringrequired
planLicensePlanOutrequired
keyMaskedstringrequired
orderIdOrderId | nullrequired
orderNumberstringrequired
buyerEmailstringrequired
stateLicenseStaterequired
clockLicenseClockrequired

16 more fields

startedAtTimestamp | nullrequired
expiresAtTimestamp | nullrequired
activatedAtTimestamp | nullrequired
devicesUsedintegerrequired
maxDevicesinteger | nullrequired
validationsintegerrequired
lastValidatedAtTimestamp | nullrequired
assignedAtTimestamp | nullrequired
productPausedbooleanrequired
extraSecondsintegerrequired
revokedReasonstringrequired
maxDevicesOverrideinteger | nullrequired
devicesLicenseDevice[]required
eventsLicenseEvent[]required
checkoutSessionIdCheckoutSessionId | nullrequired
buyerResetsobjectrequired
- used30dintegerrequired
- per30dintegerrequired

Example

curl -X POST "https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk/actions" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "revoke"
}'

const res = await fetch('https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk/actions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "kind": "revoke"
  }),
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();

import os, requests

res = requests.request(
    "POST",
    "https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk/actions",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
    json={
      "kind": "revoke"
    },
)
res.raise_for_status()
data = res.json()

req, _ := http.NewRequest("POST", "https://api.shopfa.st/v1/store/licenses/key_0123456789abcdefghjk/actions", strings.NewReader(`{
  "kind": "revoke"
}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)

Try it with your key

API base URLAPI key or token

licenseId

Body

Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.