Skip to main content
GET
Retrieve Waitlist Entry

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, an account access token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

waitlist_entry:read
plan:waitlist:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Waitlist signup ID, prefixed entry_.

Svar

signup

account_id
string
påkrævet

The seller account, prefixed biz_.

Eksempel:

"biz_xxxxxxxxxxxxxx"

approval_failure_reason
enum<string> | null
påkrævet

Why the last approval attempt failed, or null when none has. plan_unavailable — the variant, product, or seller account was deleted. already_member — the user already has a membership on a one-per-user product. checkout_failed — checkout failed, usually a declined payment, and the signup was denied. unknown — another failure; retry. Cleared when approval is requeued.

Tilgængelige muligheder:
plan_unavailable,
already_member,
checkout_failed,
unknown,
null
Eksempel:

"plan_unavailable"

buyer_account
object | null
påkrævet

The account the signup was submitted on behalf of, or null when the user signed up for themselves.

buyer_account_id
string | null
påkrævet

The account the signup was submitted on behalf of, prefixed biz_, or null when the user signed up for themselves.

Eksempel:

null

created_at
string
påkrævet

When this signup was submitted, as an ISO 8601 timestamp.

Eksempel:

"2026-01-01T12:00:00.000Z"

custom_field_responses
object[]
påkrævet
id
string
påkrævet

The waitlist signup ID, prefixed entry_.

Eksempel:

"entry_xxxxxxxxxxxxxx"

membership_id
string | null
påkrævet

The membership created for this signup, prefixed mem_, or null when there is none. Check the membership's status to determine access.

Eksempel:

null

metadata
object
påkrævet

Custom key-value metadata associated with this signup.

Eksempel:
product
object | null
påkrævet

The product this signup belongs to, or null when the variant has no product.

product_id
string | null
påkrævet

The product this signup belongs to, prefixed prod_, or null when the variant has no product.

Eksempel:

"prod_xxxxxxxxxxxxxx"

status
enum<string>
påkrævet

The signup's current state. Approval runs asynchronously, so a signup stays pending until processing completes. approved alone does not prove an active membership; check membership_id.

Tilgængelige muligheder:
pending,
approved,
denied,
canceled
Eksempel:

"canceled"

updated_at
string
påkrævet

When this signup last changed, as an ISO 8601 timestamp.

Eksempel:

"2026-01-01T12:00:00.000Z"

user
object
påkrævet

The user who submitted this signup. For a signup an account's own credential submitted, the account's owner.

user_id
string
påkrævet

The user who submitted this signup, prefixed user_. For a signup an account's own credential submitted, the account's owner.

Eksempel:

"user_xxxxxxxxxxxxxx"

variant
object
påkrævet

The variant this signup belongs to.

variant_id
string
påkrævet

The variant this signup belongs to, prefixed plan_.

Eksempel:

"plan_xxxxxxxxxxxxxx"