Skip to main content
GET
Get the pairing status of a trial
  • Credential: none. The pairing code in token identifies the trial, and the prospect sees that code. Call this operation from your backend only, never from a browser: see How a trial works.
  • Events: none. A call made after the pairing window ended, for a trial that the prospect has not paired, sets the trial to revoked and sends no event: see Statuses.
  • Personal data: paired_handle, the prospect’s phone number or the email address of their Apple ID. Request it only when needed, do not copy it into logs, tickets or other tools, and refer to a prospect by an id of your own.
  • Trial key: the first call after pairing returns trial_api_key, if it is made within 1 hour of pairing. Every later call omits it.
  • Retries: do not retry this call automatically: the first read after pairing returns the trial key once. See Read the status and the trial key.
  • Caching: the response carries Cache-Control: no-store, whatever its status.
  • Rate limit: each call counts against the request-rate limit.

Errors

The errors that every operation shares are in Errors.

Query Parameters

token
string
required

The pairing code, as returned in token by POST /v1/trial/init. Case-insensitive, and surrounding spaces are ignored. From 1 to 64 characters.

Required string length: 1 - 64
Example:

"K7M2XQ9"

Response

The state of the trial.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The state of a trial, read from its pairing code.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.