Skip to main content

CreateFunctionRegistrationInput

Defines the input details for creating a function registration in an event without capturing information for any guests.

input CreateFunctionRegistrationInput {
  contactId: ID!
  customFields: [CustomFieldInput!]
  discountCodeId: ID
  eventId: ID!
  functionFeeTypeId: ID!
  overridePaymentSchedule: [CreateOverridePaymentScheduleItemInput!]
  paymentDetails: CreatePaymentDetailsInput!
  paymentScheduleSource: PaymentScheduleSource
  taxOverrides: [TaxOverrideInput!]
  temporaryHoldContextId: ID
  tickets: PositiveInt!
}

Fields​

CreateFunctionRegistrationInput.contactId ● ID! non-null scalar​

The identifier of the contact.

CreateFunctionRegistrationInput.customFields ● [CustomFieldInput!] list input​

The custom fields to create for the function registration. Optional.

CreateFunctionRegistrationInput.discountCodeId ● ID scalar​

The identifier of the discount code to apply to the registration. Optional.

CreateFunctionRegistrationInput.eventId ● ID! non-null scalar​

The identifier of the event the function is associated with.

CreateFunctionRegistrationInput.functionFeeTypeId ● ID! non-null scalar​

The identifier of the function fee type for the registration.

CreateFunctionRegistrationInput.overridePaymentSchedule ● [CreateOverridePaymentScheduleItemInput!] list input​

The list of payment schedule items to override the default payment schedule, required when paymentScheduleSource is set to CUSTOM. Optional.

CreateFunctionRegistrationInput.paymentDetails ● CreatePaymentDetailsInput! non-null input​

The payment details for the registration.

CreateFunctionRegistrationInput.paymentScheduleSource ● PaymentScheduleSource enum​

The source of the payment schedule for the function registration. Optional.

Will default to USE_DEFAULT if the function has usePaymentSchedule set to TRUE otherwise default to NO_PAYMENT_SCHEDULE.

CreateFunctionRegistrationInput.taxOverrides ● [TaxOverrideInput!] list input​

The collection of taxes for the function registration booking that will override the taxes from setup. Optional.

When set to null, the default taxes for the function registration will be applied. When set to an empty array, no taxes will be applied.

CreateFunctionRegistrationInput.temporaryHoldContextId ● ID scalar​

A user-defined identifier representing the context for any previously created holds. If this field is specified, any outstanding hold on the registration and its discount code will automatically be released when the registration is successfully created. Optional.

CreateFunctionRegistrationInput.tickets ● PositiveInt! non-null scalar​

The number of tickets to register. Defaults to 1.

Member Of​

createFunctionRegistration mutation