Skip to main content

CreateRegistrationInput

Defines the input for creating a registration.

input CreateRegistrationInput {
  comment: String
  contactId: ID!
  customFields: [CustomFieldInput!]
  dateTime: DateTime!
  discountCodeId: ID
  eventId: ID!
  overridePaymentSchedule: [CreateOverridePaymentScheduleItemInput!]
  paymentDetails: CreatePaymentDetailsInput!
  paymentScheduleSource: PaymentScheduleSource
  registrationTypeId: ID!
  taxOverrides: [TaxOverrideInput!]
  temporaryHoldContextId: ID
}

Fields​

CreateRegistrationInput.comment ● String scalar​

The comments for this registration. Optional.

CreateRegistrationInput.contactId ● ID! non-null scalar​

The identifier of the contact the registration is associated with.

CreateRegistrationInput.customFields ● [CustomFieldInput!] list input​

The custom fields to create for the registration. Optional.

CreateRegistrationInput.dateTime ● DateTime! non-null scalar​

The date and time that the registration occurred.

CreateRegistrationInput.discountCodeId ● ID scalar​

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

CreateRegistrationInput.eventId ● ID! non-null scalar​

The identifier of the event the registration is associated with.

CreateRegistrationInput.overridePaymentSchedule ● [CreateOverridePaymentScheduleItemInput!] list input​

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

CreateRegistrationInput.paymentDetails ● CreatePaymentDetailsInput! non-null input​

The payment details for the registration.

CreateRegistrationInput.paymentScheduleSource ● PaymentScheduleSource enum​

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

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

CreateRegistrationInput.registrationTypeId ● ID! non-null scalar​

The identifier of the registration type the registration is associated with.

CreateRegistrationInput.taxOverrides ● [TaxOverrideInput!] list input​

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

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

CreateRegistrationInput.temporaryHoldContextId ● ID scalar​

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

Member Of​

createRegistration mutation