Skip to main content

UpdateRegistrationInput

Defines the input for updating a registration.

input UpdateRegistrationInput {
  cancelationTaxOverrides: [TaxOverrideInput!]
  comment: String
  contactId: ID!
  customFields: [CustomFieldInput!]
  dateTime: DateTime
  discountCodeId: ID
  eventId: ID!
  overridePaymentSchedule: [UpdateOverridePaymentScheduleItemInput!]
  paymentDetails: UpdatePaymentDetailsInput
  paymentScheduleSource: PaymentScheduleSource
  registrationId: ID!
  registrationTypeId: ID
  taxOverrides: [TaxOverrideInput!]
}

Fields​

UpdateRegistrationInput.cancelationTaxOverrides ● [TaxOverrideInput!] list input​

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

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

UpdateRegistrationInput.comment ● String scalar​

The comments for this registration. Optional.

UpdateRegistrationInput.contactId ● ID! non-null scalar​

The identifier of the contact.

UpdateRegistrationInput.customFields ● [CustomFieldInput!] list input​

The custom fields to update or create for the registration. Optional.

UpdateRegistrationInput.dateTime ● DateTime scalar​

The date and time that the registration occurred. Optional.

UpdateRegistrationInput.discountCodeId ● ID scalar​

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

UpdateRegistrationInput.eventId ● ID! non-null scalar​

The identifier of the event the registration is associated with.

UpdateRegistrationInput.overridePaymentSchedule ● [UpdateOverridePaymentScheduleItemInput!] list input​

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

Passing null or an empty list will remove all of the payment schedule items from the registration. Omitting the input value entirely will keep the existing payment schedule items as-is. When passing a list, for any existing payment schedule items where the id is not provided the payment schedule item will be removed.

UpdateRegistrationInput.paymentDetails ● UpdatePaymentDetailsInput input​

The payment details for the registration. Optional.

UpdateRegistrationInput.paymentScheduleSource ● PaymentScheduleSource enum​

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

If set to null, will default to USE_DEFAULT if the registration type has usePaymentSchedule set to TRUE otherwise will default to NO_PAYMENT_SCHEDULE.

UpdateRegistrationInput.registrationId ● ID! non-null scalar​

The identifier of the registration.

UpdateRegistrationInput.registrationTypeId ● ID scalar​

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

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

Member Of​

updateRegistration mutation