Skip to main content
POST
Deny Waitlist Entry

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an App API key, an account access token, an account-scoped user 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

plan:waitlist:manage

Başlıklar

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Örnek:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Yol Parametreleri

id
string
gerekli

Waitlist signup ID, prefixed entry_.

Yanıt

current signup state

account_id
string
gerekli

The seller account, prefixed biz_.

Örnek:

"biz_xxxxxxxxxxxxxx"

approval_failure_reason
enum<string> | null
gerekli

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.

Mevcut seçenekler:
plan_unavailable,
already_member,
checkout_failed,
unknown,
null
Örnek:

"plan_unavailable"

buyer_account
object | null
gerekli

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

buyer_account_id
string | null
gerekli

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

Örnek:

null

created_at
string
gerekli

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

Örnek:

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

custom_field_responses
object[]
gerekli
id
string
gerekli

The waitlist signup ID, prefixed entry_.

Örnek:

"entry_xxxxxxxxxxxxxx"

membership_id
string | null
gerekli

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

Örnek:

null

metadata
object
gerekli

Custom key-value metadata associated with this signup.

Örnek:
product
object | null
gerekli

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

product_id
string | null
gerekli

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

Örnek:

"prod_xxxxxxxxxxxxxx"

status
enum<string>
gerekli

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.

Mevcut seçenekler:
pending,
approved,
denied,
canceled
Örnek:

"canceled"

updated_at
string
gerekli

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

Örnek:

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

user
object
gerekli

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

user_id
string
gerekli

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

Örnek:

"user_xxxxxxxxxxxxxx"

variant
object
gerekli

The variant this signup belongs to.

variant_id
string
gerekli

The variant this signup belongs to, prefixed plan_.

Örnek:

"plan_xxxxxxxxxxxxxx"