RegistrationOpportunityResource

  • allow_file_uploads
    Type: boolean
    required
  • archived_at
    Type: string | nullFormat: ISO 8601 (UTC)
    required
  • can_user_purchase
    Type: boolean | null
    required

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

  • class_limit
    Type: integer | null
    required

    Integer numbers.

  • collect_additional_information
    Type: boolean
    required
  • created_at
    Type: stringFormat: ISO 8601 (UTC)
    required
  • deleted_at
    Type: string | nullFormat: ISO 8601 (UTC)
    required
  • description
    Type: string | null
    required
  • display_to_all_users
    Type: boolean
    required
  • dob_validation
    Type: boolean
    required
  • event_end_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required
  • event_end_time
    Type: string | nullFormat: HH:mm:ss
    required
  • event_start_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required
  • event_start_time
    Type: string | nullFormat: HH:mm:ss
    required
  • exclude_from_reminder_emails
    Type: boolean
    required
  • file_uploads_max
    Type: integer | null
    required

    Integer numbers.

  • file_uploads_required
    Type: boolean | null
    required
  • force_additional_member_info
    Type: boolean
    required
  • form_id
    Type: integer | null
    required

    Integer numbers.

  • free
    Type: boolean
    required
  • hide_from_non_buyers
    Type: boolean
    required
  • highest_price
    Type: integer | null
    required

    Highest price tier available for this registration opportunity.

  • id
    Type: integer
    required

    Integer numbers.

  • ignore_gst
    Type: boolean
    required
  • is_event
    Type: boolean
    required
  • is_full
    Type: boolean | null
    required

    Whether the registration opportunity has reached its capacity limit.

  • is_priority_waitlist_locked
    Type: boolean
    required
  • lowest_price_excluded
    Type: integer | null
    required

    Lowest price available excluding special member pricing.

  • max_date_of_birth
    Type: string | nullFormat: YYYY-MM-DD
    required

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

  • member_savings
    Type: integer | null
    required

    Member discount savings compared to guest pricing.

  • min_date_of_birth
    Type: string | nullFormat: YYYY-MM-DD
    required

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

  • multiple_signups
    Type: boolean
    required
  • name
    Type: string
    required
  • num_signups_remaining_for_user
    Type: integer | null
    required

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

  • ongoing
    Type: boolean
    required
  • parent_program_id
    Type: integer | null
    required

    Integer numbers.

  • pay_by_cash
    Type: boolean
    required
  • price_for_user
    Type: integer | null
    required

    Price for the currently authenticated user based on membership status.

  • price_id_for_user
    Type: string | null
    required

    Stripe price ID applicable for the authenticated user.

  • price_interval_count_for_user
    Type: integer | null
    required

    Number of intervals between each billing cycle.

  • price_interval_for_user
    Type: string | null
    required

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

  • price_recurs_for_user
    Type: boolean | null
    required

    Whether the user's price is a recurring subscription.

  • product_id
    Type: string | null
    required
  • program_prices
    Type: array | null
    required
  • prompt_for_number_of_guests
    Type: boolean
    required
  • prompt_for_registrant
    Type: boolean
    required
  • readable_event_end_date
    Type: string | null
    required
  • readable_event_end_time
    Type: string | null
    required
  • readable_event_start_date
    Type: string | null
    required
  • readable_event_start_time
    Type: string | null
    required
  • readable_registration_end_date
    Type: string | null
    required
  • readable_registration_start_date
    Type: string | null
    required
  • registration_end_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required
  • registration_end_time
    Type: string | null
    required
  • registration_open_until_event_start
    Type: boolean
    required
  • registration_start_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required
  • registration_start_time
    Type: string | null
    required
  • required_membership_id_for_user
    Type: string | null
    required

    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.

  • required_membership_names
    Type: array string[]
    required

    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).

  • signup_count
    Type: integer | null
    required

    Total number of active signups for this registration opportunity.

  • spots_remaining
    Type: integer | null
    required

    Number of spots remaining before the registration opportunity is full.

  • status
    Type: string
    required
  • updated_at
    Type: stringFormat: ISO 8601 (UTC)
    required
  • user_signup_count
    Type: integer | null
    required

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

  • volunteer_price
    Type: integer | null
    required

    Special discounted price for volunteers.

  • volunteer_price_is_free
    Type: boolean | null
    required

    Whether the registration opportunity is free for volunteers.

  • waitlist_enabled
    Type: boolean
    required
  • attendance_sheets
    Type: string

    Attendance sheets for this registration opportunity.

  • metadata
    Type: string
  • occurrences
    Type: string

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

  • parent_program
    Type: string

    Program this registration opportunity belongs to.

  • prices
    Type: string

    Pricing tiers available for this registration opportunity.

  • recurrence_rule
    Type: string

    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.

  • signups
    Type: string

    Signups registered for this registration opportunity.

  • waitlist_signups
    Type: string

    Users on the waitlist for this registration opportunity.

  • waivers
    Type: string