Trials

Get trials for a store

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Query parameters

customer_idstring · flake-idOptional

Filters trials by the customer identifier.

Example: 411486491630370816

subscription_idstring · flake-idOptional

Filters trials by the associated subscription identifier.

Example: 411486491630370816

checkout_idstring · flake-idOptional

Filters trials by the checkout session identifier that initiated them.

Example: 411486491630370816

trial_idstring · flake-idOptional

Filters to a specific trial by its identifier.

Example: 411486491630370816

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRead-onlyRequired

The human-readable formatted version of the trial identifier.

store_idstring · flake-idRequiredExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

product_idstring · flake-idRequiredExample: 411486491630370816

product_version_idstring · flake-idRequiredExample: 411486491630370816

product_namestringRequired

The name of the product being trialed.

product_image_urlstring · nullableOptional

The URL of the product image, if available.

period_valueinteger · int32Required

The duration value of the trial period.

period_scalestringRequired

The timescale unit for the trial period (e.g., "days", "weeks", "months").

starts_atstring · nullableOptional

The date and time when the trial period starts, if applicable.

ends_atstring · nullableOptional

The date and time when the trial period ends, if applicable.

statusstring · enumRequiredPossible values:

created_atstring · date-timeRequired

The date and time when the trial was created.

canceled_atstring · nullableOptional

The date and time when the trial was canceled, if applicable.

default

Error response

application/json

get

/v1/stores/{storeId}/trials

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/trials HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T23:00:32.610Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "text",
    "product_image_url": null,
    "period_value": 1,
    "period_scale": "text",
    "starts_at": null,
    "ends_at": null,
    "status": "created",
    "created_at": "2026-02-18T23:00:32.610Z",
    "canceled_at": null,
    "canceled_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Get a trial by ID for a store

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

trialIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRead-onlyRequired

The human-readable formatted version of the trial identifier.

store_idstring · flake-idRequiredExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

product_idstring · flake-idRequiredExample: 411486491630370816

product_version_idstring · flake-idRequiredExample: 411486491630370816

product_namestringRequired

The name of the product being trialed.

product_image_urlstring · nullableOptional

The URL of the product image, if available.

period_valueinteger · int32Required

The duration value of the trial period.

period_scalestringRequired

The timescale unit for the trial period (e.g., "days", "weeks", "months").

starts_atstring · nullableOptional

The date and time when the trial period starts, if applicable.

ends_atstring · nullableOptional

The date and time when the trial period ends, if applicable.

statusstring · enumRequiredPossible values:

created_atstring · date-timeRequired

The date and time when the trial was created.

canceled_atstring · nullableOptional

The date and time when the trial was canceled, if applicable.

default

Error response

application/json

get

/v1/stores/{storeId}/trials/{trialId}

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/trials/{trialId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "checkout_id": "411486491630370816",
  "checkout_line_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": null
    },
    "steam_id": "76561197960287930",
    "steam": {
      "id": "76561197960287930",
      "name": "text",
      "avatar_url": "text"
    },
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "name": "notch",
      "avatar_url": "text"
    },
    "xbox_xuid": null,
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2026-02-18T23:00:32.610Z",
    "updated_at": null,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "product_name": "text",
  "product_image_url": null,
  "period_value": 1,
  "period_scale": "text",
  "starts_at": null,
  "ends_at": null,
  "status": "created",
  "created_at": "2026-02-18T23:00:32.610Z",
  "canceled_at": null,
  "canceled_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Get trial eligibility overrides for a specific customer

get

Retrieves all trial eligibility overrides for the specified customer.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve trial eligibility overrides for.

Example: 411486491630370816

customerIdstring · flake-idRequired

The ID of the customer to retrieve trial eligibility overrides for.

Example: 411486491630370816

Query parameters

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRead-onlyRequired

The human-readable formatted version of the override identifier.

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

product_idstring · flake-idRequiredExample: 411486491630370816

product_namestringRequired

The name of the product associated with this override.

product_image_urlstring · nullableOptional

The URL of the product image, if available.

created_atstring · date-timeRequired

The date and time when this override was created.

expires_atstring · date-timeRequired

The date and time when this override expires and is no longer valid.

used_atstring · nullableOptional

The date and time when this override was used to start a trial, if applicable.

used_on_trial_idstring · flake-idOptionalExample: 411486491630370816

notestring · nullableOptional

An optional note or comment about this override.

deleted_atstring · nullableOptional

The date and time when this override was deleted, if applicable.

default

Error response

application/json

get

/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "product_id": "411486491630370816",
    "product_name": "text",
    "product_image_url": null,
    "created_at": "2026-02-18T23:00:32.610Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "expires_at": "2026-02-18T23:00:32.610Z",
    "used_at": null,
    "used_on_trial_id": "411486491630370816",
    "note": null,
    "deleted_at": null,
    "deleted_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Create trial eligibility override for a customer

post

Creates a new trial eligibility override for the specified customer.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to create the trial eligibility override for.

Example: 411486491630370816

customerIdstring · flake-idRequired

The ID of the customer to create the trial eligibility override for.

Example: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

product_idstring · flake-idRequiredExample: 411486491630370816

expires_atstring · date-timeRequired

notestringOptional

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRead-onlyRequired

The human-readable formatted version of the override identifier.

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

product_idstring · flake-idRequiredExample: 411486491630370816

product_namestringRequired

The name of the product associated with this override.

product_image_urlstring · nullableOptional

The URL of the product image, if available.

created_atstring · date-timeRequired

The date and time when this override was created.

expires_atstring · date-timeRequired

The date and time when this override expires and is no longer valid.

used_atstring · nullableOptional

The date and time when this override was used to start a trial, if applicable.

used_on_trial_idstring · flake-idOptionalExample: 411486491630370816

notestring · nullableOptional

An optional note or comment about this override.

deleted_atstring · nullableOptional

The date and time when this override was deleted, if applicable.

default

Error response

application/json

post

/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "product_id": "411486491630370816",
  "expires_at": "2026-02-18T23:00:32.610Z",
  "note": "text"
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "product_id": "411486491630370816",
  "product_name": "text",
  "product_image_url": null,
  "created_at": "2026-02-18T23:00:32.610Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "expires_at": "2026-02-18T23:00:32.610Z",
  "used_at": null,
  "used_on_trial_id": "411486491630370816",
  "note": null,
  "deleted_at": null,
  "deleted_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Delete trial eligibility override for a customer

delete

Deletes an existing trial eligibility override.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to delete the trial eligibility override for.

Example: 411486491630370816

trialEligibilityOverrideIdstring · flake-idRequired

The ID of the trial eligibility override to delete.

Example: 411486491630370816

customerIdstringRequired

Responses

204

No Content

default

Error response

application/json

delete

/v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides/{trialEligibilityOverrideId}

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/customers/{customerId}/trials/eligibility/overrides/{trialEligibilityOverrideId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content