Skip to main content
GET
Check user connection status to the paywall

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Paywall-User
string

Optional user identifier provided by the developer. Can be used instead of the user property in the request body to associate the API call with a specific end user.

Query Parameters

user
string

The unique identifier of the user to check connection status for.

Response

200 - application/json

User is connected to the paywall.

Response structure when a user is connected and authorized to be charged via the paywall.

connected
boolean

Boolean indicating that the user is connected and authorized.

connectedUser
object

Information about a user who has successfully connected to a paywall. Includes internal and external user identifiers and the associated paywall key.

message
string

Human-readable message confirming the connection status.