Skip to main content
A Waitlist Entry is a user’s signup for a variant that requires seller approval. Joining doesn’t grant a membership or charge a payment method; the seller approves or denies each signup. Use the Waitlist Entries API to join a waitlist, read or cancel your own signups, and approve or deny the signups for accounts you operate.

Endpoints

Attributes

string
required
The waitlist signup ID, prefixed entry_.
string
required
The seller account, prefixed biz_.
string | null
required
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.Available options: plan_unavailable, already_member, checkout_failed, unknown
string | null
required
The account the signup was submitted on behalf of, prefixed biz_, or null when the user signed up for themselves.
string
required
When this signup was submitted, as an ISO 8601 timestamp.
object[]
required
The buyer’s answers to checkout questions.

Properties

string
required
The answer’s ID, prefixed cfrp_.
string
required
The buyer’s answer.
string
required
The question shown when the signup was submitted.
string | null
required
The membership created for this signup, prefixed mem_, or null when there is none. Check the membership’s status to determine access.
object
required
Custom key-value metadata associated with this signup.
string
required
The variant this signup belongs to, prefixed plan_.
string | null
required
The product this signup belongs to, prefixed prod_, or null when the variant has no product.
string
required
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.Available options: pending, approved, denied, canceled
string
required
When this signup last changed, as an ISO 8601 timestamp.
string
required
The user who submitted this signup, prefixed user_.
WaitlistEntry