The merchant's plan, usage and entitlements

Error

A valid request URL is required to generate request examples

{
  "num_active_collections": 123,
  "max_active_collections": 123,
  "is_trial": true,
  "trial_days_left": 123,
  "proj_sessions": 123,
  "num_sessions": 123,
  "max_sessions": 123,
  "days_until_reset": 123,
  "frozen": true,
  "installed_recently": true,
  "store_error": "invalid_api_key",
  "subscription": {
    "id": 123,
    "name": "Basic",
    "price": "<string>",
    "interval": "EVERY_30_DAYS",
    "billing_on": "<string>",
    "trial_ends_on": "<string>",
    "test": true,
    "status": "pending"
  },
  "entitlements": {
    "plan_id": "<string>",
    "products": [
      "search"
    ],
    "size": "s",
    "session_quota": 123,
    "max_active_collections": 123,
    "is_trial": true,
    "trial_days_left": 123,
    "features": {
      "ab_test": true,
      "scheduled_versions": true,
      "multi_store": true
    },
    "source": "foundation"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

settings

subscription

status

Error

A valid request URL is required to generate request examples

{
  "num_active_collections": 123,
  "max_active_collections": 123,
  "is_trial": true,
  "trial_days_left": 123,
  "proj_sessions": 123,
  "num_sessions": 123,
  "max_sessions": 123,
  "days_until_reset": 123,
  "frozen": true,
  "installed_recently": true,
  "store_error": "invalid_api_key",
  "subscription": {
    "id": 123,
    "name": "Basic",
    "price": "<string>",
    "interval": "EVERY_30_DAYS",
    "billing_on": "<string>",
    "trial_ends_on": "<string>",
    "test": true,
    "status": "pending"
  },
  "entitlements": {
    "plan_id": "<string>",
    "products": [
      "search"
    ],
    "size": "s",
    "session_quota": 123,
    "max_active_collections": 123,
    "is_trial": true,
    "trial_days_left": 123,
    "features": {
      "ab_test": true,
      "scheduled_versions": true,
      "multi_store": true
    },
    "source": "foundation"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.

Query Parameters

merchant_id

string

required

Lite merchant id, e.g. shopify-<shop id>.

Response

The subscription status.

num_active_collections

integer

required

max_active_collections

integer | null

required

is_trial

boolean

required

trial_days_left

integer | null

required

proj_sessions

integer | null

required

Sessions projected for this month; null before 4 days of data.

num_sessions

integer

required

max_sessions

integer | null

required

days_until_reset

integer

required

frozen

boolean

required

installed_recently

boolean

required

store_error

enum<string> | null

required

Available options:

invalid_api_key,

payment_required,

unknown,

null

subscription

object | null

required

The active Shopify app subscription, if any.

Show child attributes

entitlements

object

required

The plan-derived rights every portal gate reads.

Show child attributes