Skip to main content

MembershipCategory

Represents a membership category.

type MembershipCategory {
  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!
  feeTypes: [MembershipFeeType!]!
  id: ID!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  name: String!
  uniqueCode: String
}

Fields​

MembershipCategory.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

MembershipCategory.createdBy ● String scalar​

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

MembershipCategory.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 category.

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).
MembershipCategory.customFields.input ● CustomFieldSearchFilterInput! non-null input​
MembershipCategory.customFields.limit ● PaginationLimit! non-null scalar​
MembershipCategory.customFields.offset ● NonNegativeInt! non-null scalar​

MembershipCategory.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.
MembershipCategory.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input​
MembershipCategory.customFieldsPaged.limit ● PaginationLimit! non-null scalar​
MembershipCategory.customFieldsPaged.offset ● NonNegativeInt! non-null scalar​

MembershipCategory.feeTypes ● [MembershipFeeType!]! non-null interface​

A list of fee types associated with this membership category.

MembershipCategory.id ● ID! non-null scalar​

The unique identifier for a membership category.

MembershipCategory.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

MembershipCategory.lastModifiedBy ● String scalar​

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

MembershipCategory.name ● String! non-null scalar​

A UTF-8 string representing the name of the membership category.

MembershipCategory.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the membership category. Optional.

The value must be unique across all membership categories for an event.

Member Of​

CreateMembershipCategoryPayload object ● EventsAirMembershipRegistration object ● ExternalMembershipRegistration object ● MembershipRegistration interface ● MembershipSetup object ● UpdateMembershipCategoryPayload object