# Returns a registration setting from the system by its ID.

This method will look up a registration setting by the specified ID and return it back.

Endpoint: GET /registrationSettings/{tenantId}/public/{id}
Version: v1-2025-04-18

## Path parameters:

  - `tenantId` (string, required)
    The id of the tenant being accessed.

  - `id` (string, required)
    The ID of the registration setting to return.

## Query parameters:

  - `fields` (string)
    The fields that you want to retrieve; if omitted, the entire object is returned.

  - `consistentRead` (string)
    Indicates the API should force a consistent read on the data source.

## Response 200 fields (application/json):

  - `allow_customer_to_choose_installment_plan` (boolean)
    If true, the customer can choose their installment plan

  - `bank_account_id` (string, required)
    The default bank account that the store should use to receive payments

  - `bill_my_organization_options` (object)

  - `bill_my_organization_options.billing_address` (string)
    Enum: "do not show", "optional", "required"

  - `bill_my_organization_options.purchase_order_number` (string)
    Enum: "do not show", "optional", "required"

  - `bill_my_organization_options.reference_number` (string)
    The reference #

  - `bill_my_parent_organization_options` (object)

  - `business_unit_id` (string, required)
    The business unit of the store

  - `cancellation_deadline` (string, required)

  - `cancellation_fee_product_id` (string)
    The ID of the product used for cancellation fees

  - `cancellation_policy` (string)
    Enum: "none", "relative date", "specific date"

  - `cancellation_relative_date` (object, required)

  - `cancellation_relative_date.number` (number, required)
    The unit of time

  - `cancellation_relative_date.position` (string, required)
    How the unit relates to the reference date
    Enum: "after", "before", "on"

  - `cancellation_relative_date.relative_to` (string, required)
    Enum: "the beginning of the month", "the beginning of the quarter", "the beginning of the week", "the beginning of the year", "the end of the month", "the end of the quarter", "the end of the week", "the end of the year", "the reference date"

  - `cancellation_relative_date.unit_of_time` (string, required)
    Enum: "days", "months", "weeks", "years"

  - `certificate_mode` (string)
    Enum: "automatically generate", "create manually", "disabled"

  - `certificate_template` (string, required)

  - `certification_credit_options` (object, required)

  - `certification_credit_options.applicable_registration_type_ids` (array)
    The applicable registration types; leave blank for all non-guest registrations

  - `certification_credit_options.credits` (array, required)

  - `certification_credit_options.credits.credit_type_id` (string, required)
    The type of credit

  - `certification_credit_options.credits.quantity` (number, required)
    The number of credits to assign

  - `certification_credit_options.mark_as_verified` (boolean)
    If true, the credits should be marked as verified

  - `certification_credit_options.single_quantity_credits` (boolean)
    If set to true, the system will only generate credits with a quantity of 1; so specifying 4 will generate 4 credits with a quantity of 1 rather than 1 credit with qty 4

  - `checkout_donation_options` (object, required)

  - `checkout_donation_options.simple_checkout_donation_options` (object)

  - `checkout_donation_options.simple_checkout_donation_options.allow_user_to_specify_custom_amount` (boolean)
    If set, the user can specify their own custom donation

  - `checkout_donation_options.simple_checkout_donation_options.donation_ask_text` (string)
    The text shown to the user when making the donation

  - `checkout_donation_options.simple_checkout_donation_options.donation_denominations` (array)

  - `checkout_donation_options.simple_checkout_donation_options.donation_information` (string)
    Additional information about the donation

  - `checkout_donation_options.simple_checkout_donation_options.donation_product_id` (string, required)
    The misc product that should be used

  - `checkout_donation_options.simple_checkout_donation_options.override_donation_denominations` (boolean)
    If set, donation denominations are specified here and the defaults are not used

  - `checkout_donation_options.simple_checkout_donation_options.suggested_donation` (number)
    A suggested donation

  - `checkout_donation_options.type` (string)
    Enum: "simple"

  - `course_registration_settings` (object, required)

  - `course_registration_settings.course_reg_process_id` (string, required)
    The process for course registration

  - `credit_card_minimum_range_end` (number)
    If set, the maximum amount for which credit cards can be taken

  - `credit_card_minimum_range_start` (number)
    If set, the minimum amount for which credit cards can be taken

  - `credit_card_mode` (string)
    Determines whether or not credit cards are accepted
    Enum: "disabled", "enabled", "range"

  - `credit_card_processing_fee_mode` (string)
    Determines how credit card processing fees should be handled
    Enum: "charge", "do not charge", "prompt user"

  - `credit_card_processing_fee_options` (object, required)

  - `credit_card_processing_fee_options.fee_percentage` (number, required)
    The fee percentage to charge for credit card processing

  - `credit_card_processing_fee_options.maximum_fee` (number)
    The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

  - `credit_card_processing_fee_options.minimum_fee` (number)
    The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

  - `credit_card_processing_fee_options.product_id` (string, required)
    The misc product to use for the credit card processing

  - `credit_card_processing_fee_options.prompt_sub_text` (string)
    Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

  - `credit_card_processing_fee_options.prompt_text` (string)
    The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

  - `custom_order_preprocessing_options` (object, required)

  - `custom_order_preprocessing_options.lambda_function_id` (string, required)
    The custom lambda function to use

  - `custom_order_pricing_options` (object, required)

  - `default_registration_process_id` (string)
    The default registration process, which can be used for registrations that have no process (such as imported registrations)

  - `disable_electronic_payment_vaulting` (boolean)
    If set, in the portal people are not allowed to save credit cards

  - `enable_bill_my_organization` (boolean)
    If set, the user has the option to bill their organization

  - `enable_bill_my_parent_organization` (boolean)
    If set, the user has the option to bill their organization's parent organization

  - `enable_certification_credits` (boolean)
    If true, then this event will generate certification credits

  - `enable_course_registration` (boolean)
    If true, registrants can access certification

  - `enable_custom_order_preprocessing` (boolean)
    If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

  - `enable_custom_order_pricing` (boolean)
    If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

  - `enable_donations_at_checkout` (boolean)
    If selected, users will be prompted to make a donation upon checking out

  - `enable_electronic_checks` (boolean)
    If set, electronic checks are allowed

  - `enable_group_registration` (boolean)
    Whether or not group registration is enabled

  - `enable_pay_later` (boolean)
    If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

  - `enable_payroll_deduction` (boolean)
    If set, payroll deduction is allowed

  - `enable_split_payments` (boolean)
    If set, users are allowed to split payments

  - `enable_webinar_integration` (boolean)
    If selecting, registration will be linked to an external webinar service

  - `group_registration_options` (object, required)

  - `group_registration_options.allow_users_to_update_organization` (boolean)
    If true, users can update the organization details during the group registration process

  - `group_registration_options.close_date` (string)
    When group registration should be closed. If not set, it will close when the event closes.

  - `group_registration_options.confirmation_email_recipient` (string)
    Enum: "both", "group administrator", "registrant"

  - `group_registration_options.contact_form_html` (string)
    Special instructions to show on the contact form

  - `group_registration_options.contact_form_id` (string, required)
    The contact form to show to group administrators when they are registering individuals

  - `group_registration_options.contact_role_ids` (array)
    The contact roles that can perform group registration

  - `group_registration_options.enable_tiered_discounts` (boolean)
    If set, then the system will automatically discount registrants from the same organization/group based on rules you specify

  - `group_registration_options.group_administrator_confirmation_email` (object)

  - `group_registration_options.group_administrator_confirmation_email.bcc` (string)
    Anyone that should be bcc'ed on the email

  - `group_registration_options.group_administrator_confirmation_email.body` (string, required)
    The email body

  - `group_registration_options.group_administrator_confirmation_email.cc` (string)
    Anyone that should be cc'ed on the email

  - `group_registration_options.group_administrator_confirmation_email.from` (string)
    From email address

  - `group_registration_options.group_administrator_confirmation_email.from_name` (string)
    From name

  - `group_registration_options.group_administrator_confirmation_email.reply_to` (string)
    The reply to

  - `group_registration_options.group_administrator_confirmation_email.subject` (string, required)
    The email subject

  - `group_registration_options.open_date` (string)
    When group registration should be open

  - `group_registration_options.organization_form_html` (string)
    Special instructions to show on the organization form

  - `group_registration_options.organization_form_id` (string)
    The organization form to show to group administrators when they are registering an organization

  - `group_registration_options.restrict_to_specific_contact_roles` (boolean)
    If true, only certain contact roles can perform group registration

  - `group_registration_options.send_confirmation_email_to_group_administrator` (boolean)
    If true, an email is sent to the administrator of the group once registration is complete

  - `group_registration_options.tiered_discount_rules` (array)

  - `id` (string, required)
    The unique, string identifier of this registration setting

  - `installment_plan_options` (array, required)

  - `installment_plan_options.additional_cost` (number)
    The additional cost of the installment plan

  - `installment_plan_options.installment_plan_id` (string, required)
    The installment plan that this product supports

  - `installment_plan_options.is_default` (boolean)
    Whether this is the default installment plan option

  - `invoice_payment_terms_id` (string)
    The payment terms for invoices; if left blank, default is used

  - `invoice_template_id` (string)
    The template to use for invoices created during this process

  - `maximum_number_of_registrants_from_the_same_organization` (number, required)

  - `membership_renewal_window` (number)
    When prompting for membership renewal during the event, the number of days during which if the member is expiring, they are prompted to renew

  - `merchant_account_id` (string, required)
    The merchant account that the store should use to receive payments

  - `notes` (string)
    Notes about the settings

  - `pay_later_options` (object)

  - `registration_deadlines` (array, required)
    The registration deadline dates

  - `registration_deadlines.date` (string)
    The deadline date & time

  - `registration_deadlines.deadline_id` (string, required)
    The deadline

  - `restocking_fee_product_id` (string)
    The ID of the product used for restocking fees

  - `restrict_registrants_from_same_organization` (boolean)
    If checked, then the system will restrict how many people from the same organization can register for this event

  - `special_instructions` (string)
    Instructions shown to the user

  - `sys_bulk_load_at` (string)
    If this record was loaded via bulk, the timestamp when the record was processed

  - `sys_bulk_load_id` (string)
    If this record was loaded via bulk, the ID of the bulk load process

  - `sys_bulk_load_pk` (string)
    If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

  - `sys_bulk_load_record_no` (number)
    If this record was loaded via bulk, the record number in the source file

  - `sys_bulk_load_source_file` (string)
    If this record was loaded via bulk, the source file

  - `sys_calculated_field_error` (string)
    The error associated with the calculated field

  - `sys_calculated_field_errors` (array)

  - `sys_calculated_field_errors.error` (string)

  - `sys_calculated_field_errors.field` (string)

  - `sys_configuration_snapshot_id` (string)
    If a snapshot was restored/applies to this record, the ID of the snapshot

  - `sys_created_at` (string, required)
    The date/time that this record was created, expressed in ISO-8601 date format

  - `sys_created_by_id` (string, required)
    The ID of the user that created this record

  - `sys_deleted_by_id` (string)
    The ID of the user that deleted (or last tried to delete) this object

  - `sys_directive` (string)
    Means for passing directive information into an object processing logic

  - `sys_external_id` (string)
    The ID that a record has from an external system or data import

  - `sys_has_files_in_s3` (boolean)
    If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

  - `sys_last_bulk_data_operation_id` (string)
    If this record was last touched by a bulk data operation, the ID of that operation

  - `sys_last_bulk_data_operation_sys_version` (string)
    If this record was last touched by a bulk data operation, the sys_version at the time of that operation

  - `sys_last_modified_at` (string, required)
    The date/time that this record record was last modified, expressed in ISO-8601 date format

  - `sys_last_modified_by_id` (string, required)
    The ID of the user that last modified this record

  - `sys_last_security_context` (object)
    The security context of the last insert, modify, or delete performed on this item

  - `sys_locked` (boolean)
    If set, this record is locked and cannot be changed via the API

  - `sys_snapshot_base_version` (number)
    The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

  - `sys_version` (number)
    A number representing the version of this record in the database

  - `use_pro_forma_invoices` (boolean)
    Whether to use pro forma invoices when user elects to pay later

  - `use_registration_deadlines` (boolean)
    Whether or not registration should have deadlines

  - `webinar_integration_options` (object, required)

  - `webinar_integration_options.meeting_id` (string)
    The meeting id

  - `webinar_integration_options.type` (string)
    The video conference type
    Enum: "meeting", "webinar"

  - `webinar_integration_options.webinar_account_id` (string, required)
    The account ID

  - `webinar_integration_options.webinar_id` (string)
    The webinar id

  - `webinar_integration_options.webinar_service` (string, required)
    The integration service
    Enum: "integrations-zoom-accounts"


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields