Skip to content
ExtensionsStorefronts
extensions / Commerce extension
GET/__runtime/subscription/free_trial/hash

Get Free Trial Hash

Evaluates free-trial eligibility for a storefront subscription and returns a claim hash, redirect, or ineligibility reason.

GET

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Permissions

  • Public storefront endpoint resolved from the request Host; an authenticated storefront session is optional.

Headers

NameRequiredTypeDetails
CookieYesNot specified
Description: Value used by this operation.
AuthorizationYesNot specified
Description: Bearer credential used to authenticate the request.

Path Parameters

This operation has no path parameters.

Query Parameters

NameRequiredTypeDetails
subscription_idNostring
Description: Identifier for subscription.
device_hashNostring
Description: Text value.

Request Body

This operation does not accept a request body.

Response Body

Example 200 response

json
{
  "eligible": "string",
  "reason": "string",
  "claimed": "string",
  "status": "active",
  "redirect_url": "string",
  "hash": "string",
  "requires_signup": "string",
  "signup_url": "string"
}

Errors

400 BAD_REQUEST500 INTERNAL_SERVER_ERROR

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified