ExternalMembershipRegistration

Represents a membership registration associated with a contact for an external membership store.

type ExternalMembershipRegistration implements MembershipRegistration {
  cancelationTaxes: [AppliedTax!]!
  category: MembershipCategory!
  comment: String
  contact: Contact!
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]! @deprecated
  customFieldsPaged(
    filterInput: CustomFieldAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): CustomFieldPage!
  feeType: MembershipFeeType!
  id: ID!
  isActive: Boolean!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  membershipEndDate: LocalDate
  membershipStartDate: LocalDate
  paymentEndDate: LocalDate
  paymentStartDate: LocalDate
  taxes: [AppliedTax!]!
  type: MembershipRegistrationType!
}

Fields

ExternalMembershipRegistration.cancelationTaxes ● [AppliedTax!]! non-null object

The list of cancelation taxes that apply to the external membership registration booking.

ExternalMembershipRegistration.category ● MembershipCategory! non-null object

The membership category of the membership registration.

ExternalMembershipRegistration.comment ● String scalar

The comment associated with the membership registration. Optional.

ExternalMembershipRegistration.contact ● Contact! non-null object

The contact associated with the membership registration.

ExternalMembershipRegistration.createdAt ● DateTime! non-null scalar

The date and time the record was created.

ExternalMembershipRegistration.createdBy ● String scalar

UTF-8 string value that represents the username of the user who created the record. Optional.

ExternalMembershipRegistration.customFields ● [CustomField!]! deprecated non-null object

DEPRECATED

Use customFieldsPaged instead. It returns the same custom fields together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

A list of custom field values associated with this membership registration.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

• offset must be a non-negative integer (defaults to 0).
• limit must be a positive integer from 1 to 2000 (defaults to 100).

ExternalMembershipRegistration.customFields.input ● CustomFieldSearchFilterInput! non-null input

ExternalMembershipRegistration.customFields.limit ● PaginationLimit! non-null scalar

ExternalMembershipRegistration.customFields.offset ● NonNegativeInt! non-null scalar

ExternalMembershipRegistration.customFieldsPaged ● CustomFieldPage! non-null object

Custom fields associated with this record that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See CustomFieldAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn).

Optionally, the offset and limit arguments can be used to page through multiple items:

• offset must be a non-negative integer (defaults to 0).
• limit must be a positive integer from 1 to 2000 (defaults to 100).

Throws an error with code:

• BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.

ExternalMembershipRegistration.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input

ExternalMembershipRegistration.customFieldsPaged.limit ● PaginationLimit! non-null scalar

ExternalMembershipRegistration.customFieldsPaged.offset ● NonNegativeInt! non-null scalar

ExternalMembershipRegistration.feeType ● MembershipFeeType! non-null interface

The membership fee type of the membership registration.

ExternalMembershipRegistration.id ● ID! non-null scalar

The unique identifier for a membership registration.

ExternalMembershipRegistration.isActive ● Boolean! non-null scalar

The flag indicating if the membership registration is active or canceled.

ExternalMembershipRegistration.lastModifiedAt ● DateTime! non-null scalar

The date and time the record was last modified.

ExternalMembershipRegistration.lastModifiedBy ● String scalar

UTF-8 string value that represents the username of the user who last modified the record. Optional.

ExternalMembershipRegistration.membershipEndDate ● LocalDate scalar

The membership end date of a recurring membership registration. Optional.

ExternalMembershipRegistration.membershipStartDate ● LocalDate scalar

The membership start date of a recurring membership registration. Optional.

ExternalMembershipRegistration.paymentEndDate ● LocalDate scalar

The payment end date of a recurring membership registration. Optional.

ExternalMembershipRegistration.paymentStartDate ● LocalDate scalar

The payment start date of a recurring membership registration. Optional.

ExternalMembershipRegistration.taxes ● [AppliedTax!]! non-null object

The list of taxes that apply to the external membership registration booking.

ExternalMembershipRegistration.type ● MembershipRegistrationType! non-null enum

A value indicating the type of the membership registration item.

Interfaces

MembershipRegistration interface

Represents a membership registration associated with a contact in EventsAir.

Member Of

CreateMembershipRegistrationPayload object ● UpdateMembershipRegistrationPayload object