Skip to main content
GET
Get the all-access pass

Request

Headers

This endpoint is public, like /products: no sign-in is needed to show the pass price on a catalog page. It is only meaningful on digital stores. The pass covers every listed product the seller marked as included, for 30 days from each purchase.

Successful response

When the store has no pass on sale (never configured, or switched off) pass is null:
To buy the pass, add it to the cart with { "allAccess": true } using Add item to cart.

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Response

200 - application/json

The pass, or null.

status
integer
Example:

200

success
boolean
Example:

true

message
string
Example:

"Pass retrieved"

data
object
Example: