> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # Charge an explicitly authorized saved event card > Attempts an off-session Stripe card charge for a pending positive order after recording the donor authorization. The donor must match the purchaser, the reference must remain eligible, and reviewed amount must match. Confirmed success completes the order; failure leaves it pending. An indeterminate or concurrent result returns 409 and requires reconciliation. Retry the same authorization key and method; a new key cannot bypass an unresolved attempt. ## OpenAPI ````yaml post /admin/events/{eventId}/orders/{orderId}/charge-saved-payment-method openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /admin/events/{eventId}/orders/{orderId}/charge-saved-payment-method: post: tags: - Events summary: Charge an explicitly authorized saved event card description: >- Attempts an off-session Stripe card charge for a pending positive order after recording the donor authorization. The donor must match the purchaser, the reference must remain eligible, and reviewed amount must match. Confirmed success completes the order; failure leaves it pending. An indeterminate or concurrent result returns 409 and requires reconciliation. Retry the same authorization key and method; a new key cannot bypass an unresolved attempt. operationId: EventRegistrationController_chargeSavedPaymentMethod parameters: - name: eventId in: path description: Record ID in the authenticated organization. required: true schema: type: integer example: 42 example: 42 - name: orderId in: path description: Record ID in the authenticated organization. required: true schema: type: integer example: 42 example: 42 requestBody: required: true content: application/json: schema: required: - payer_donor_id - payment_method_reference - reviewed_amount - authorization_confirmed - authorization_statement_version - idempotency_key properties: payer_donor_id: description: Accessible donor matching the registration purchaser. type: integer example: 42 payment_method_reference: description: Fresh eligible opaque reference from saved-payment-methods. type: string maxLength: 4096 example: issued-encrypted-reference reviewed_amount: description: >- Amount reviewed with donor; must exactly match order total in processor minor units. type: number minimum: 0.01 example: 25 authorization_confirmed: description: Must be accepted to record the donor authorization. type: boolean example: true authorization_statement_version: description: Current authorization statement version. type: string enum: - event_saved_method_v1 example: event_saved_method_v1 idempotency_key: description: >- Stable key for this authorized attempt; repeat unchanged after an indeterminate outcome. type: string maxLength: 120 example: authorized-charge-1 type: object responses: '200': description: Charge an explicitly authorized saved event card completed. content: application/json: schema: properties: data: $ref: '#/components/schemas/EventApiPublicOrder' type: object '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Insufficient permission or feature access. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Resource not found in the organization or feature unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '409': description: >- Payment requires reconciliation or the processor account is restricted. content: application/json: schema: properties: message: description: Explanation. type: string example: The prior payment result could not be confirmed. data: $ref: '#/components/schemas/EventApiPublicOrder' status: description: Availability error status when restricted. type: string example: error error_code: description: Availability error code when restricted. type: string example: CHECKOUT_PAYMENT_UNAVAILABLE payment_availability: description: Processor availability when restricted. type: object additionalProperties: true type: object '422': description: Invalid authorization, amount, method or rejected charge. content: application/json: schema: properties: message: description: Validation/charge failure message. type: string example: The saved payment method could not be charged. data: $ref: '#/components/schemas/EventApiPublicOrder' errors: description: Field errors on validation failure. type: object additionalProperties: true type: object '503': description: Processor availability could not be confirmed. content: application/json: schema: properties: status: description: Error status. type: string example: error error_code: description: Error code. type: string example: CHECKOUT_PAYMENT_UNAVAILABLE message: description: Provider availability explanation. type: string example: Payments are temporarily unavailable. payment_availability: description: Processor availability result. type: object additionalProperties: true type: object security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: EventApiPublicOrder: properties: id: description: Order ID. type: integer example: 42 order_number: description: Order number. type: string example: EVT-42-001 status: description: Order lifecycle. type: string example: completed payment_status: description: Payment state. type: string example: paid payment_method: description: Payment method. type: string example: Example nullable: true payment_instructions: description: Check instructions; null for other methods. type: string example: Example nullable: true gateway: description: Gateway identifier. type: string example: Example nullable: true payment_intent_id: description: Provider reference. type: string example: Example nullable: true subtotal_amount: description: Subtotal amount. type: number minimum: 0 example: 25 discount_amount: description: Discount amount. type: number minimum: 0 example: 25 donation_amount: description: Donation amount. type: number minimum: 0 example: 25 fees_covered_amount: description: Fees covered amount. type: number minimum: 0 example: 25 tax_deductible_amount: description: Tax deductible amount. type: number minimum: 0 example: 25 non_deductible_amount: description: Non deductible amount. type: number minimum: 0 example: 25 total_amount: description: Total amount. type: number minimum: 0 example: 25 currency: description: Event currency. type: string example: USD purchaser_name: description: Buyer name. type: string example: Example nullable: true purchaser_email: description: Buyer email. type: string example: Example nullable: true version: description: Optimistic version required when editing V2 orders. type: string example: >- sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reservation_expires_at: description: Pending V2 reservation deadline. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true quote_fingerprint: description: V2 quote fingerprint. type: string example: Example nullable: true quote_snapshot: description: V2 quote or empty legacy collection. oneOf: - $ref: '#/components/schemas/EventApiRegistrationQuote' - type: array items: type: string maxItems: 0 line_items: description: >- Saved line items; source-specific fields differ between legacy and V2 orders. type: array items: properties: type: description: >- Line source (ticket, sponsor_package, auction_item, auction_bid or donation_addon). type: string example: ticket label: description: Description. type: string example: General admission ticket_type_id: description: Ticket ID on ticket lines. type: integer example: 42 sponsor_package_id: description: Package ID on package lines. type: integer example: 42 auction_item_id: description: Item ID on auction lines. type: integer example: 42 auction_bid_id: description: Bid ID on bid lines. type: integer example: 42 quantity: description: Units. type: integer example: 42 unit_amount: description: Unit amount. type: number minimum: 0 example: 25 line_total: description: Line total. type: number minimum: 0 example: 25 fair_market_total: description: Fair market total. type: number minimum: 0 example: 25 discount: description: Discount. type: number minimum: 0 example: 25 admissions_per_unit: description: V2 slots per unit. type: integer example: 42 admissions: description: V2 admissions on this line. type: integer example: 42 source_snapshot: properties: name: description: Product name. type: string example: General admission code: description: Ticket code; null for packages. type: string example: Example nullable: true tier: description: Package tier; null for tickets. type: string example: Example nullable: true registration_group_kind: description: Group kind. type: string example: individual group_label_prompt: description: Prompt for naming this group. type: string example: Example nullable: true attendee_details_timing: description: When guest details are needed. type: string enum: - checkout - before_event - optional example: checkout admissions_per_unit: description: Admission slots for one unit. type: integer example: 42 unit_amount: description: Price of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' fair_market_value: description: Fair market value of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' type: object type: object metadata: properties: registration_version: description: 2 for grouped registration; otherwise null. type: integer example: 42 nullable: true conversion_intents: description: Enabled interest flags or an empty list. oneOf: - properties: recurring_gift: description: Requested monthly giving. type: boolean example: false child_sponsorship: description: Requested sponsorship. type: boolean example: false type: object - type: array items: type: string maxItems: 0 sponsorship_interest: properties: program_id: description: Sponsorship program. type: integer example: 42 recipient_id: description: Chosen public recipient. type: integer example: 42 recipient_label: description: Public recipient name. type: string example: Alex url: description: Public recipient route. type: string example: /frontend/view_entity/42/7/9 type: object nullable: true type: object receipt_snapshot: description: Completed receipt snapshot, or empty before issue. oneOf: - properties: receipt_type: description: Receipt type. type: string example: event_combined_receipt event_id: description: Event ID. type: integer example: 42 event_name: description: Event name. type: string example: Annual Gala order_number: description: Order number. type: string example: EVT-42-001 donation_id: description: Linked donation ID. type: integer example: 42 nullable: true currency: description: Currency. type: string example: USD subtotal_amount: description: Subtotal amount. type: number minimum: 0 example: 25 discount_amount: description: Discount amount. type: number minimum: 0 example: 25 fees_covered_amount: description: Fees covered amount. type: number minimum: 0 example: 25 total_amount: description: Total amount. type: number minimum: 0 example: 25 tax_deductible_amount: description: Tax deductible amount. type: number minimum: 0 example: 25 non_deductible_amount: description: Non deductible amount. type: number minimum: 0 example: 25 donation_amount: description: Donation amount. type: number minimum: 0 example: 25 payment_method: description: Method. type: string example: Example nullable: true payment_status: description: Payment state. type: string example: paid payment_instructions: description: Pay-by-check instructions. type: string example: Example nullable: true line_items: description: >- Saved line items; source-specific fields differ between legacy and V2 orders. type: array items: properties: type: description: >- Line source (ticket, sponsor_package, auction_item, auction_bid or donation_addon). type: string example: ticket label: description: Description. type: string example: General admission ticket_type_id: description: Ticket ID on ticket lines. type: integer example: 42 sponsor_package_id: description: Package ID on package lines. type: integer example: 42 auction_item_id: description: Item ID on auction lines. type: integer example: 42 auction_bid_id: description: Bid ID on bid lines. type: integer example: 42 quantity: description: Units. type: integer example: 42 unit_amount: description: Unit amount. type: number minimum: 0 example: 25 line_total: description: Line total. type: number minimum: 0 example: 25 fair_market_total: description: Fair market total. type: number minimum: 0 example: 25 discount: description: Discount. type: number minimum: 0 example: 25 admissions_per_unit: description: V2 slots per unit. type: integer example: 42 admissions: description: V2 admissions on this line. type: integer example: 42 source_snapshot: properties: name: description: Product name. type: string example: General admission code: description: Ticket code; null for packages. type: string example: Example nullable: true tier: description: Package tier; null for tickets. type: string example: Example nullable: true registration_group_kind: description: Group kind. type: string example: individual group_label_prompt: description: Prompt for naming this group. type: string example: Example nullable: true attendee_details_timing: description: When guest details are needed. type: string enum: - checkout - before_event - optional example: checkout admissions_per_unit: description: Admission slots for one unit. type: integer example: 42 unit_amount: description: Price of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' fair_market_value: description: Fair market value of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' type: object type: object issued_at: description: Issue time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true receipt_note: description: Receipt guidance. type: string example: >- Ticket fair market value is separated from deductible event support. adjustment_type: description: Receipt adjustment kind. type: string enum: - refund - cancellation example: refund refunded_amount: description: Recorded refund amount when adjusted. type: number minimum: 0 example: 25 active_total_amount: description: Remaining active total after adjustment. type: number minimum: 0 example: 25 active_tax_deductible_amount: description: Remaining active deductible amount after adjustment. type: number minimum: 0 example: 25 adjustment_reason: description: Cancellation reason when adjusted. type: string example: Example nullable: true adjusted_at: description: Adjustment time when adjusted. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object - type: array items: type: string maxItems: 0 receipt_sent_at: description: Receipt send timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true registration_questions: type: array items: properties: field_key: description: Stable field key. type: string example: dietary field_label: description: Question label. type: string example: Dietary requirements field_type: description: Question type. type: string example: text options: type: array items: description: Configured option. type: string example: Vegetarian scope: description: Answer scope. type: string enum: - buyer - group - attendee example: buyer required: description: Whether an answer is required. type: boolean example: false id: description: Question ID. type: integer example: 42 help_text: description: Question help. type: string example: Example nullable: true applies_to_ticket_type_ids: type: array items: description: Applicable ticket type. type: integer example: 42 type: object event: properties: id: description: Event ID. type: integer example: 42 branding_program_id: description: Branding context. type: integer example: 42 nullable: true name: description: Event name. type: string example: Annual Gala slug: description: Slug. type: string example: annual-gala starts_at: description: Start time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true timezone: description: Timezone. type: string example: Africa/Kampala location: description: Location filtered by the order management disclosure policy. properties: mode: description: Effective disclosure mode. type: string example: released_full label: description: Disclosed location label. type: string example: Kampala venue: description: Disclosed venue name. type: string example: Example nullable: true address: description: Released full address. type: string example: Example nullable: true map_allowed: description: Whether the disclosed address may be mapped. type: boolean example: false type: object type: object registration_groups: type: array items: properties: id: description: Group ID. type: integer example: 42 source_kind: description: Source kind. type: string example: ticket source_id: description: Ticket/package ID. type: integer example: 42 event_ticket_type_id: description: Ticket ID. type: integer example: 42 nullable: true kind: description: Registration group kind. type: string example: individual label: description: Group label. type: string example: Example nullable: true admissions_reserved: description: Guest slots. type: integer example: 42 attendee_details_timing: description: Details policy. type: string enum: - checkout - before_event - optional example: checkout status: description: Group state. type: string example: complete source_snapshot: description: Saved product snapshot or empty list. oneOf: - properties: name: description: Product name. type: string example: General admission code: description: Ticket code; null for packages. type: string example: Example nullable: true tier: description: Package tier; null for tickets. type: string example: Example nullable: true registration_group_kind: description: Group kind. type: string example: individual group_label_prompt: description: Prompt for naming this group. type: string example: Example nullable: true attendee_details_timing: description: When guest details are needed. type: string enum: - checkout - before_event - optional example: checkout admissions_per_unit: description: Admission slots for one unit. type: integer example: 42 unit_amount: description: Price of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' fair_market_value: description: Fair market value of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' type: object - type: array items: type: string maxItems: 0 details_completed_at: description: Required details completion. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true answers: type: array items: $ref: '#/components/schemas/EventApiRegistrationAnswer' attendee_ids: type: array items: description: Guest attendee ID. type: integer example: 42 type: object attendees: type: array items: properties: id: description: Attendee ID. type: integer example: 42 event_registration_group_id: description: Group ID. type: integer example: 42 nullable: true event_ticket_type_id: description: Ticket type ID. type: integer example: 42 nullable: true ticket_code: description: Human-readable ticket code. type: string example: EVT-42-00001 name: description: Display name. type: string example: Jane Doe first_name: description: First name. type: string example: Example nullable: true last_name: description: Last name. type: string example: Example nullable: true email: description: Email. type: string example: Example nullable: true ticket_type: description: Ticket type. type: string example: Example nullable: true table: description: Table. type: string example: Example nullable: true status: description: Guest state. type: string example: registered qr_token: description: Always null; use the authorized QR URL. type: string nullable: true details_completed_at: description: Details completion. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true qr_url: description: >- Authorized SVG route only for active tickets with complete/optional group details. type: string example: Example nullable: true wallet_pass_url: description: Wallet route only when ready and details are complete. type: string example: Example nullable: true wallet_pass_status: description: Wallet availability. type: string enum: - inactive - ready - configuration_required - disabled example: inactive checked_in_at: description: Check-in time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true answers: type: array items: $ref: '#/components/schemas/EventApiRegistrationAnswer' metadata: properties: source: description: Attendee source. type: string example: Example nullable: true event_sponsor_id: description: Sponsor source. type: integer example: 42 nullable: true sponsor_ticket_slot: description: Sponsor guest slot. type: integer example: 42 nullable: true type: object type: object sponsors: type: array items: properties: id: description: Sponsor ID. type: integer example: 42 company_name: description: Company name. type: string maxLength: 255 example: Example nullable: true contact_name: description: Contact name. type: string maxLength: 255 example: Example nullable: true contact_email: description: Contact email. type: string maxLength: 255 example: Example nullable: true contact_phone: description: Contact phone. type: string maxLength: 80 example: Example nullable: true notes: description: Notes. type: string maxLength: 5000 example: Example nullable: true status: description: State. type: string example: active amount: description: Paid package amount. type: number minimum: 0 example: 25 fair_market_value: description: Fair market value. type: number minimum: 0 example: 25 included_tickets_assigned: description: Included ticket count. type: integer example: 42 public_visibility: description: Sponsor public display consent. type: boolean example: false renewal_follow_up_at: description: Renewal reminder. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true logo_upload_id: description: Logo upload ID. type: integer example: 42 nullable: true logo_url: description: Resolved logo URL. type: string example: Example nullable: true package: properties: id: description: Package ID. type: integer example: 42 nullable: true name: description: Package name. type: string example: Example nullable: true tier: description: Tier. type: string example: Example nullable: true included_tickets: description: Included admissions. type: integer example: 42 included_tables: description: Included tables. type: integer example: 42 type: object deliverables: type: array items: properties: id: description: Deliverable ID. type: integer example: 42 type: description: Deliverable type. type: string example: logo label: description: Label. type: string example: Logo placement status: description: State. type: string example: pending due_at: description: Due time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true completed_at: description: Completion time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object type: object auction_items: type: array items: properties: id: description: Bid/purchase ID. type: integer example: 42 event_auction_item_id: description: Item ID. type: integer example: 42 name: description: Item name. type: string example: Example nullable: true amount: description: Unit amount. type: number minimum: 0 example: 25 quantity: description: Units. type: integer example: 42 status: description: Bid/purchase status. type: string example: paid bidder_name: description: Bidder name. type: string example: Example nullable: true bidder_email: description: Bidder email. type: string example: Example nullable: true type: object payment_reconciliation_required: description: >- Provider evidence needs reconciliation before further payment actions. type: boolean example: false payment_provider_status: description: Latest verified Stripe provider status. type: string example: Example nullable: true type: object ErrorResponse: title: ErrorResponse description: >- Generic error envelope used by most controllers. Most error responses pair a human-readable `message` with `status: error`. Some endpoints additionally include `errors` (validator errors), `error` (legacy single-error string), `code`, or domain-specific context fields. required: - message properties: message: description: Human-readable error message. type: string example: Something went wrong. Please try again. status: description: >- Always the literal string `error` for failures. Some endpoints omit this field. type: string example: error error: description: Legacy single error code/string used by older endpoints. type: string example: invalid_request nullable: true code: description: >- Optional application-level error code (not all endpoints populate this). type: string example: DONOR_NOT_FOUND nullable: true type: object NotFoundResponse: title: NotFoundResponse description: >- Returned with HTTP 404 when a resource lookup misses (typically because the id doesn't exist OR is scoped to a different `client_id`). Note: many endpoints intentionally collapse 'not found' and 'forbidden' into a single 404 to avoid leaking which records exist in another tenant. required: - message properties: message: description: >- Human-readable message. Often a more specific string like `Donor not found` or `Trip not found`. type: string example: Not Found status: type: string example: error type: object EventApiRegistrationQuote: properties: quote_fingerprint: description: Five-minute fingerprint of products, totals and expiry. type: string example: >- sha256:1792497900:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa expires_at: description: Quote expiry. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true currency: description: Event currency. type: string example: USD availability: properties: event_state: description: Event registration state. type: string example: open admissions_requested: description: Requested guest slots. type: integer example: 42 admissions_remaining: description: Remaining slots; null means unbounded. type: integer example: 42 nullable: true type: object lines: type: array items: properties: source: description: Product source. type: string enum: - ticket - sponsor_package example: ticket source_id: description: Ticket or package ID. type: integer example: 42 label: description: Product label. type: string example: General admission units: description: Units. type: integer example: 42 admissions_per_unit: description: Admissions per unit. type: integer example: 42 admissions: description: Admissions. type: integer example: 42 pre_reserved_units: description: Pre reserved units. type: integer example: 42 unit_amount: description: Unit amount. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' fair_market_value: description: Fair market value. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' subtotal: description: Subtotal. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' discount: description: Discount. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' total: description: Total. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' non_deductible: description: Non deductible. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' snapshot: properties: name: description: Product name. type: string example: General admission code: description: Ticket code; null for packages. type: string example: Example nullable: true tier: description: Package tier; null for tickets. type: string example: Example nullable: true registration_group_kind: description: Group kind. type: string example: individual group_label_prompt: description: Prompt for naming this group. type: string example: Example nullable: true attendee_details_timing: description: When guest details are needed. type: string enum: - checkout - before_event - optional example: checkout admissions_per_unit: description: Admission slots for one unit. type: integer example: 42 unit_amount: description: Price of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' fair_market_value: description: Fair market value of one unit. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' type: object type: object promo_code_id: description: Applied promo ID. type: integer example: 42 nullable: true promo_code: description: Applied promo code. type: string example: Example nullable: true subtotal: description: Subtotal. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' discount: description: Discount. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' fee_coverage: description: Fee coverage. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' donation: description: Donation. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' tax_deductible: description: Tax deductible. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' non_deductible: description: Non deductible. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' total: description: Total. type: string pattern: ^[0-9]+[.][0-9]{2}$ example: '25.00' attendee_slots: description: Total admissions. type: integer example: 42 type: object EventApiRegistrationAnswer: properties: id: description: Answer ID. type: integer example: 42 question_id: description: Question ID. type: integer example: 42 nullable: true question: properties: field_key: description: Stable field key. type: string example: dietary field_label: description: Question label. type: string example: Dietary requirements field_type: description: Question type. type: string example: text options: type: array items: description: Configured option. type: string example: Vegetarian scope: description: Answer scope. type: string enum: - buyer - group - attendee example: buyer required: description: Whether an answer is required. type: boolean example: false type: object nullable: true answer: description: >- Question value. Text accepts up to 500 characters (textarea 5000, email 255, phone 80); date uses YYYY-MM-DD, select/radio require an offered option, checkbox/multiselect use distinct offered strings (maximum 50), acknowledgement uses true/false or 1/0. Blank values clear managed answers. example: Vegetarian nullable: true type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.