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, unknownobject | null
required
The account the signup was submitted on behalf of, or
null when the user signed up for themselves.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
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.
object | null
required
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, canceledstring
required
When this signup last changed, as an ISO 8601 timestamp.
object
required
The user who submitted this signup. For a signup an account’s own credential submitted, the account’s owner.
Properties
Properties
string
required
User ID, prefixed
user_.string | null
required
Display name.
object
required
Avatar wrapper; its
url is always present, using a generated placeholder when the user set no picture.Properties
Properties
string
required
Avatar image URL. Always present — a generated placeholder when the user set no picture.
string
required
Public username.
string
required
The user who submitted this signup, prefixed
user_. For a signup an
account’s own credential submitted, the account’s owner.object
required
The variant this signup belongs to.
Properties
Properties
string
required
Variant ID, prefixed
plan_.number | null
required
Number of days between recurring charges, such as 30 for monthly or 365 for
annual.
null for one-time variants.string
required
Billing model for this variant:
one_time or renewal.Available options: renewal, one_timestring | null
required
Customer-visible variant description. Maximum 1000 characters.
null if no
description is set.object
required
What checkout charges up front.
amount is "0.00" when the first charge is free, such as a trial.Properties
Properties
string
required
The amount in major units, as an exact decimal string —
"10.00" is ten
dollars. A string so no float rounds it in transit.string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself
runs at.
integer
required
How many decimal places to SHOW. Usually equal to
decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.object
required
The recurring charge every
billing_period days. amount is "0.00" for one-time variants.Properties
Properties
string
required
The amount in major units, as an exact decimal string —
"10.00" is ten
dollars. A string so no float rounds it in transit.string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — the precision the charge itself
runs at.
integer
required
How many decimal places to SHOW. Usually equal to
decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.string | null
required
Variant display name shown to customers.
null if no title has been set.number | null
required
Free trial days configured before the first renewal charge.
null if no trial is configured.string
required
The variant this signup belongs to, prefixed
plan_.WaitlistEntry

