Schemas

Whether the current viewer may update this record.

The attendance sheet this record belongs to.

The program signup (attendee) this record tracks.

Registration opportunity identifiers linked to this attendance sheet.

Whether the current viewer may update or delete this sheet.

Whether the current viewer may register a person from this sheet.

Program this attendance sheet belongs to (derived from first registration opportunity).

Registration opportunities this attendance sheet includes.

Attendance records for this sheet.

Public identifier used by guest form links.

Quoted cost in integer cents.

Optional calendar label.

Whether the owner may still cancel this request.

Unix timestamp of starting_at in UTC.

Resolved booking contact. Prefer this over the raw user/guest/organization relations.

Facility this request is for. Slim {id, name} by default; the full bookable entity is returned when include=bookableEntity is sent.

Workflow state. Slim {id, state_name, color} by default; the full state model is returned when include=bookingState is sent.

The state this request advances to next in the facility's workflow. Present when append=next_state is requested; null when the request is already in the final state.

The state this request can be moved back to. Present when append=previous_state is requested; null when the request is in the first state.

The unique identifier of the activity log entry.

Unique request hash for tracing the request from API call to delivery.

Human-readable message describing the card delivery event.

ISO 8601 timestamp of when the card was delivered.

Unix timestamp of when the card was delivered.

The ID of the user who received the card.

The member ID of the user who received the card.

Array of obfuscated email addresses where the card was sent.

Array of obfuscated email addresses that failed to send.

Total number of emails sent.

Types of membership cards delivered.

Delivery status.

Failure reason if status is failed.

Error message associated with the failure.

The unique identifier of the facility.

How bookings are made: instant confirms immediately, request needs a manager to approve.

The id of the facility this one sits inside, or null when it is a top-level facility.

The maximum number of people the facility holds.

The length in minutes of each bookable slot.

The shortest bookable duration, in hours.

The longest bookable duration, in hours.

How many days ahead members may book.

The time of day booking slots are aligned from.

How many hours before the start time a booking request must be submitted.

Instructions shown to members when they book.

Whether members may create repeating bookings themselves.

Whether members must give a reason when booking.

Whether the facility's schedule is visible to the public.

Whether the public schedule also accepts bookings.

Whether the public schedule hides who made each booking.

Whether only managers may book the facility.

Whether the booking form asks who the booking is for.

Whether the booking form asks for additional members to add.

Whether the booking form asks how many guests are attending.

Stripe product ids of the memberships a member must hold to book, or null when the facility is open to everyone.

Whether a member needs any one (or) or all (and) of memberships_required.

Whether the facility is currently bookable or has been archived.

Position of the facility in the manually ordered list.

ISO 8601 timestamp of when the facility was archived, or null while it is active.

ISO 8601 timestamp of when the facility was created.

ISO 8601 timestamp of when the facility was last changed.

The facility this one sits inside. Included when the parent relation is requested.

The sub-facilities inside this one. Included when the children relation is requested.

Relations

When true (add-ons only), the add-on is only offered bundled with its base; the base is not listed alone.

Whether the authenticated member is blocked from purchasing a membership because their coverage is provided through a family group holder's membership instead. Only computed on the show endpoint for an authenticated member; null otherwise (e.g. guests, or contexts that don't compute this, such as the index listing).

Whether the authenticated member can purchase this membership type according to MembershipTypePolicy::purchase. Only computed on the show endpoint for authenticated members; null otherwise.

Waivers associated with this membership type.

Plans associated with this membership type.

Raw per-locale values and their provenance for the manager translation editor, plus each field's translation mode (auto translates into every supported locale, source shows the English value everywhere). Omitted for non-manager readers.

Raw per-locale values and their provenance for the manager translation editor, plus each field's translation mode (auto translates into every supported locale, source shows the English value everywhere). Omitted for non-manager readers.

Unique identifier for the program.

Display name of the program shown to users.

Detailed description of the program, may contain HTML.

When the program's events begin. All registration opportunities run within this window.

When the program's events end. All registration opportunities run within this window.

When registration opens for this program. Users cannot sign up before this date.

When registration closes for this program. Users cannot sign up after this date.

Whether this is an ongoing program with no fixed end date.

Current status of the program (e.g. Active, Archived, Draft, Upcoming, Ongoing, Past, dates_not_set when no aggregate event window exists).

Human-readable formatted event date range for display.

Human-readable formatted registration date range for display.

Whether this program represents a single event rather than a series of registration opportunities.

Whether this program is in draft mode and not yet published.

Whether this program is hidden from public listings.

URL to the program's profile/header image.

Legacy capacity limit alias retained for compatibility with existing clients.

Total number of signup spots across all registration opportunities.

Number of remaining spots available to be claimed.

Total active signups across registration opportunities.

Number of spots reserved by capped registration opportunities.

Number of signups currently consuming reserved spots.

Remaining reserved spots after reserved signups are counted.

Number of spots available to uncapped registration opportunities.

Number of signups currently consuming uncapped spots.

Remaining uncapped spots after uncapped signups are counted.

Audience demographic label for this program.

Instructor or facilitator name shown for this program.

Optional display name for the physical location.

Optional street address for the location.

Latitude for map display when a location is set.

Longitude for map display when a location is set.

Whether the program is delivered online.

Human-readable event start date in tenant timezone.

Human-readable event end date in tenant timezone.

Event start time in tenant timezone (24-hour HH:mm).

Event end time in tenant timezone (24-hour HH:mm).

Registration open time in tenant timezone (24-hour HH:mm).

Registration close time in tenant timezone (24-hour HH:mm).

Whether this program is display-only and not intended for signup.

Unsplash credit author name for the selected profile image.

Unsplash credit URL for the selected profile image author.

Whether users may submit multiple signups for this program.

Whether checkout prompts for number of guests.

Whether checkout prompts for registrant selection.

Whether waitlist functionality is enabled for this program.

Whether participants must be selected before checkout.

Whether participants can view the participant list for this program.

Whether enrollment counts, participant avatars, and spots remaining are hidden on the program page.

Whether this program allows cash payment option.

Registration fee amount in minor currency units (for example, cents).

Whether registration fee is applied once per checkout instead of per signup.

Whether this program is configured to ignore tenant tax rates.

Whether additional signup form data should be collected.

Whether emergency contact information is required at signup.

Whether facility calendars should be blocked by this program.

Whether registration opportunities under this program are automatically archived after their event dates pass.

Number of days after event_end_date to wait before auto-archiving (0 = immediately).

Whether the selected participant for a signup must hold the membership that gates the chosen price tier.

Optional linked form identifier for additional questions.

Whether registrants are allowed to upload files during signup.

Whether at least one file upload is required at signup.

Maximum number of files allowed per signup, or null for default behavior.

Volunteer opportunity identifiers linked to this program.

Facility identifiers linked to this program.

Display order for sorting in listings.

Whether this item is pinned in the recommended sort order.

GL code for accounting/financial reporting on program transactions.

When this record was created.

When this record was last updated.

When this record was soft deleted, null if not deleted.

When this program was archived, null if not archived.

Facilities/locations where this program takes place.

Registration opportunities available for registration under this program.

Best currently available member pricing savings versus guest pricing.

Volunteer opportunities associated with this program.

Waiver assignments associated with this program.

Gross amount paid for this signup, in cents (principal only, before refunds). For subscription signups, this is the sum of installment transactions; for one-off signups, it falls back to the signup's stored amount_paid.

Absolute total refunded for this signup, in cents (principal only). Net paid = amount_paid - amount_refunded.

Timestamp set only when the signup was intentionally cancelled.

Role of the user who intentionally cancelled the signup.

Registration opportunity name, selected via join on the list endpoint so the table can render without including the full program resource. Omitted when the query does not join programs.

Program ID of the signup's registration opportunity, selected via join on the list endpoint. Omitted when the query does not join programs.

Whether the registration opportunity is free, selected via join on the list endpoint. Omitted when the query does not join programs.

User who created this signup.

Guest associated with this signup (for non-member signups).

Additional family member registered through this signup.

Registration opportunity this signup belongs to.

Payment transaction for this signup.

Files uploaded by the user as part of this signup.

Form submissions associated with this signup.

Recurring subscription schedule for this signup.

Attendance records for this signup across all dates.

Comma-separated list of activities from the program.

Whether the current viewer may manage this registration opportunity.

DOB at the minimum allowed age (youngest participant) — the latest calendar date in the range.

DOB at the maximum allowed age (oldest participant) — the earliest calendar date in the range.

Member discount savings compared to guest pricing.

Price for the currently authenticated user based on membership status.

Number of signups remaining for the authenticated user (based on signup limits).

Lowest price available excluding special member pricing.

Highest price tier available for this registration opportunity.

Total number of active signups for this registration opportunity.

Whether the registration opportunity has reached its capacity limit.

Number of spots remaining before the registration opportunity is full.

Number of signups the authenticated user has for this registration opportunity.

Special discounted price for volunteers.

Whether the registration opportunity is free for volunteers.

Stripe price ID applicable for the authenticated user.

Stripe product_id the participant must hold for this signup. Populated only when the program's participant_must_hold_membership toggle is on AND the participant_membership_enforcement feature flag is on AND the authenticated user qualifies for a membership-gated price tier. Null in every other case. Gated by ?append=... / ?include=... like the other computed-for-user fields.

Whether the user's price is a recurring subscription.

Billing interval for recurring prices (day, week, month, year).

Number of intervals between each billing cycle.

Whether the authenticated user is eligible to purchase this registration opportunity.

Distinct membership titles that grant access to purchase this registration opportunity. The field is omitted from the response entirely when the include is not requested; when requested, it is always an array (possibly empty).

Signups registered for this registration opportunity.

Program this registration opportunity belongs to.

Pricing tiers available for this registration opportunity.

Users on the waitlist for this registration opportunity.

Attendance sheets for this registration opportunity.

Discrete date/time occurrences for this registration opportunity. Ordered by persisted display position. Admin saves normalize this chronologically.

Recurrence pattern that generated this registration opportunity's occurrences, when the admin authored the schedule via the recurring builder. Display metadata only — occurrences is the operational source of truth for queries and registration.

Signed integer cents; negative for refunds.

Pre-discount amount, in integer cents.

original_amount minus amount, in integer cents.

Tax collected, in integer cents.

Platform + processing fees, in integer cents.

ISO 4217 currency code.

The integer-backed \App\Enums\TransactionType value. See readable_type for its label.

The Stripe charge id.

transaction_id of the original charge this transaction refunds, if any.

The Stripe refund id, if this transaction is a refund.

The Stripe payment refund id, if applicable.

transaction_id of the disputed charge, if this transaction is a chargeback.

Payment method used, e.g. "card" or "interac".

Card brand string.

Curated, whitelisted subset of the transaction's stored metadata. Internal-only keys (e.g. internal_flag, trigger_tax_receipt) are stripped before serialization.

The timestamp the transaction is effective as of (used for reporting/sorting).

Human-readable label for the type enum value.

Human-readable, tenant-timezone formatted creation date.

Human-readable summary of what was purchased.

net_amount = amount - fees + tax_amount, in integer cents.

Fees net of any related refund, in integer cents.

Amount still refundable, in integer cents.

Populated by ProgramSignup::transaction() via withExists; falls back to false on resources loaded outside that relation. Treat null/undefined as "unknown" (do NOT use as an authoritative gate).

Ids of bookings tied to this transaction's invoice.

Ids of booking requests tied to this transaction's invoice.

Minimal owner (frontend only needs email/name/id). Owner may be an Account, Guest, or Organization, and email is nullable on those.

Minimal invoice with bookings; only present when the invoice relation is loaded.

Minimal associated transaction so refunds can link back to the original charge's invoice and bookings; only present when the associatedTransaction relation is loaded.

Promotion code with coupon info; only present when the promotionCode relation is loaded.

Tags attached to this transaction. Optional/absent field: only present on the index endpoint with include=tags; the key is entirely absent otherwise, including on the show endpoint, which does not support include.

Minimal transaction line items (avoids expensive Program appends); only present when the transactionLineItems relation is loaded. transaction_line_itemable is a minimal id/name pair for the purchased item (e.g. a Program or Product).

The unique identifier of the user membership.

The id of the member who holds this membership.

Current membership state. retrying means the last renewal payment failed and further attempts are scheduled.

Whether the membership renews automatically at the end of the current period.

ISO 8601 timestamp of when the current membership period ends.

ISO 8601 timestamp of the most recent renewal, or null if the membership has never renewed.

ISO 8601 timestamp of when the membership was created.

The membership type this membership belongs to. Included when the relation is loaded, which both endpoints always do.

The pricing plan the membership is billed on. Included when the relation is loaded, which both endpoints always do. amount is in the smallest currency unit (e.g. cents).