Create Waitlist Entry
Joins a free waitlist variant as the authenticated user, or on behalf of an account with buyer_account_id. Requires waitlist_entry:create, on that account when one is given. Joining again returns the existing pending signup, or the approved one while its membership is valid. Paid variants are rejected; joining collects no payment method and grants no membership.
Authorizations
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.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-10-29-8"
Body
The free waitlist variant to join, prefixed plan_.
"plan_xxxxxxxxxxxxxx"
The account to join on behalf of, prefixed biz_. Leave it out to join as yourself. Required with an account credential, which passes its own account and records the account's owner as the user who joined.
Answers to the variant's checkout questions. Every required question must be answered.
Custom key-value pairs to store on the signup. Max 50 keys, 100 chars per key, 500 chars per string value. Ignored when the request returns an existing signup.
Response
joined
The seller account, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
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.
plan_unavailable, already_member, checkout_failed, unknown, null "plan_unavailable"
The account the signup was submitted on behalf of, or null when the user signed up for themselves.
The account the signup was submitted on behalf of, prefixed biz_, or null when the user signed up for themselves.
null
When this signup was submitted, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
The waitlist signup ID, prefixed entry_.
"entry_xxxxxxxxxxxxxx"
The membership created for this signup, prefixed mem_, or null when there is none. Check the membership's status to determine access.
null
Custom key-value metadata associated with this signup.
The product this signup belongs to, or null when the variant has no product.
The product this signup belongs to, prefixed prod_, or null when the variant has no product.
"prod_xxxxxxxxxxxxxx"
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.
pending, approved, denied, canceled "canceled"
When this signup last changed, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
The user who submitted this signup. For a signup an account's own credential submitted, the account's owner.
The user who submitted this signup, prefixed user_. For a signup an account's own credential submitted, the account's owner.
"user_xxxxxxxxxxxxxx"
The variant this signup belongs to.
The variant this signup belongs to, prefixed plan_.
"plan_xxxxxxxxxxxxxx"

