The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.
Like most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/
https://membership.api.rhythmsoftware.com/
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}
https://membership.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}
https://membership.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The setting was retrieved successfully.
When set, committee members are able to manage documents in the portal
If true, the customer can choose their installment plan
If true, members have the ability to update auto renewal settings in the portal
If true, members can update directory information when updating their membership
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
The template to use for showing chapter information in the portal
In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
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
The default amount of time after a members expiration during which the are "in grace"
The fields that users can opt out of
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, chapters are able to administer their members in the portal
If set, the application generation logic will call a custom lambda function
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If true, users can opt out of the directory specifically
If selected, users will be prompted to make a donation upon checking out
If set, group membership applications are enbabled
Enable a message that shows when a person has no processes available
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
Whether members have the ability to be reinstated after termination
Enable adding flowdown memberships in KPIs
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The default 360 screen for membership editing
The default page layout for membership editing
The default page layout for membership editing
The merchant account that the store should use to receive payments
If true, a custom template is used for the chapter center
If true, a custom template is used for viewing membership information
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
When set, the membership expiration is set based on the date that the membership was paid vs ordered
Whether to use pro forma invoices when user elects to pay later
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [ … ] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ { … } ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ { … } ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": { … } }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}
https://membership.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The setting was patched successfully.
When set, committee members are able to manage documents in the portal
If true, the customer can choose their installment plan
If true, members have the ability to update auto renewal settings in the portal
If true, members can update directory information when updating their membership
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
The template to use for showing chapter information in the portal
In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
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
The default amount of time after a members expiration during which the are "in grace"
The fields that users can opt out of
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, chapters are able to administer their members in the portal
If set, the application generation logic will call a custom lambda function
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If true, users can opt out of the directory specifically
If selected, users will be prompted to make a donation upon checking out
If set, group membership applications are enbabled
Enable a message that shows when a person has no processes available
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
Whether members have the ability to be reinstated after termination
Enable adding flowdown memberships in KPIs
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The default 360 screen for membership editing
The default page layout for membership editing
The default page layout for membership editing
The merchant account that the store should use to receive payments
If true, a custom template is used for the chapter center
If true, a custom template is used for viewing membership information
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
When set, the membership expiration is set based on the date that the membership was paid vs ordered
Whether to use pro forma invoices when user elects to pay later
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [ … ] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ { … } ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ { … } ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": { … } }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }
The setting that you would like to be saved.
When set, committee members are able to manage documents in the portal
If true, the customer can choose their installment plan
If true, members have the ability to update auto renewal settings in the portal
If true, members can update directory information when updating their membership
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
The template to use for showing chapter information in the portal
In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
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
The default amount of time after a members expiration during which the are "in grace"
The fields that users can opt out of
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, chapters are able to administer their members in the portal
If set, the application generation logic will call a custom lambda function
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If true, users can opt out of the directory specifically
If selected, users will be prompted to make a donation upon checking out
If set, group membership applications are enbabled
Enable a message that shows when a person has no processes available
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
Whether members have the ability to be reinstated after termination
Enable adding flowdown memberships in KPIs
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The default 360 screen for membership editing
The default page layout for membership editing
The default page layout for membership editing
The merchant account that the store should use to receive payments
If true, a custom template is used for the chapter center
If true, a custom template is used for viewing membership information
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
When set, the membership expiration is set based on the date that the membership was paid vs ordered
Whether to use pro forma invoices when user elects to pay later
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}
https://membership.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"add_on_configuration": {
"dues_bundling": "inline",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons",
"singular_name": "string"
},
"allow_committee_members_to_manage_documents": true,
"allow_customer_to_choose_installment_plan": true,
"allow_members_to_update_auto_renewal_settings": true,
"allow_members_to_update_directory_options_in_portal": "disabled",
"bank_account_id": "string",
"bill_my_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"bill_my_parent_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"business_unit_id": "string",
"cancellation_fee_product_id": "string",
"certificate_mode": "automatically generate",
"certificate_template": "string",
"chapter_administration_settings": {
"chapter_page_layout_id": "string",
"contact_form_id": "string",
"membership_page_layout_id": "string",
"permissions": [
{
"access_saved_queries": true,
"committee_position_ids": [
"string"
],
"grace_period": 0.1,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"renew_existing_members": true,
"saved_queries": {
"0": {
"display_name": "string",
"saved_query_id": "string"
}
},
"sign_up_new_members": true,
"update_chapter_info": true,
"update_contact_info": true,
"update_membership_info": true,
"view_chapter_roster": true
}
]
},
"chapter_center_html_template": "string",
"chapter_configuration": {
"auto_assignment": "assign",
"dues_bundling": "inline",
"maximum_number_of_chapters_a_member_can_join": 1,
"members_are_required_to_join_a_chapter": true,
"plural_name": "string",
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members",
"singular_name": "string",
"update_chapter_when_contact_address_changes": true
},
"checkout_donation_options": {
"simple_checkout_donation_options": {
"allow_user_to_specify_custom_amount": true,
"donation_ask_text": "string",
"donation_denominations": [
0.1
],
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0.1
},
"type": "simple"
},
"conflicting_membership_preference": "organization",
"contact_role_permissions": [
{
"manage_membership_privileges": true,
"renew_membership": true,
"role_id": "string",
"sign_up_for_membership": true,
"update_membership_info": true
}
],
"credit_card_minimum_range_end": 0.1,
"credit_card_minimum_range_start": 0.1,
"credit_card_mode": "disabled",
"credit_card_processing_fee_mode": "charge",
"credit_card_processing_fee_options": {
"fee_percentage": 0.1,
"maximum_fee": 0.1,
"minimum_fee": 0.1,
"product_id": "string",
"prompt_sub_text": "string",
"prompt_text": "string"
},
"custom_application_generation_logic_options": {
"lambda_function_id": "string"
},
"custom_field_values": [
{
"boolean_value": true,
"custom_field_id": "string",
"file_url_value": "string",
"list_value": [
"string"
],
"numeric_value": 0.1,
"string_value": "string",
"table_value": [
{}
]
}
],
"custom_order_preprocessing_options": {
"lambda_function_id": "string"
},
"custom_order_pricing_options": {
"lambda_function_id": "string"
},
"default_grace_period": 0.1,
"directory_opt_out_fields": [
"string"
],
"disable_electronic_payment_vaulting": true,
"document_settings": {
"restrict_management_to_positions": true,
"restricted_position_ids": {
"0": "string"
}
},
"enable_add_ons": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_chapter_administration": true,
"enable_chapters": true,
"enable_custom_application_generation_logic": true,
"enable_custom_order_preprocessing": true,
"enable_custom_order_pricing": true,
"enable_directory_field_level_opt_out": true,
"enable_donations_at_checkout": true,
"enable_electronic_checks": true,
"enable_group_membership_applications": true,
"enable_id_cards": true,
"enable_no_processes_message": true,
"enable_pay_later": true,
"enable_payroll_deduction": true,
"enable_reinstatement": true,
"enable_sections": true,
"enable_split_payments": true,
"id_card_settings": {
"allow_printing_in_portal": true,
"default_id_card_template_id": "string"
},
"include_flowdown_members_in_kpis": true,
"installment_plan_options": [
{
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
],
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"membership_360_screen_id": "string",
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"merchant_account_id": "string",
"no_processes_message": "string",
"notes": "string",
"override_chapter_center_template": true,
"override_view_member_template": true,
"pay_later_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"reinstatement_options": {
"calculate_reinstatement_period_using": "expiration date",
"do_not_show_join_processes_during_reinstatement_period": true,
"give_renewal_pricing_during_reinstatement_period": true,
"reinstatement_period": 0.1
},
"restocking_fee_product_id": "string",
"section_configuration": {
"dues_bundling": "inline",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members",
"singular_name": "string"
},
"special_instructions": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"update_expiration_based_on_date_of_payment": true,
"use_pro_forma_invoices": true,
"view_member_html_template": "string"
}'The setting was saved successfully.
When set, committee members are able to manage documents in the portal
If true, the customer can choose their installment plan
If true, members have the ability to update auto renewal settings in the portal
If true, members can update directory information when updating their membership
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
The template to use for showing chapter information in the portal
In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
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
The default amount of time after a members expiration during which the are "in grace"
The fields that users can opt out of
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, chapters are able to administer their members in the portal
If set, the application generation logic will call a custom lambda function
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If true, users can opt out of the directory specifically
If selected, users will be prompted to make a donation upon checking out
If set, group membership applications are enbabled
Enable a message that shows when a person has no processes available
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
Whether members have the ability to be reinstated after termination
Enable adding flowdown memberships in KPIs
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The default 360 screen for membership editing
The default page layout for membership editing
The default page layout for membership editing
The merchant account that the store should use to receive payments
If true, a custom template is used for the chapter center
If true, a custom template is used for viewing membership information
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
When set, the membership expiration is set based on the date that the membership was paid vs ordered
Whether to use pro forma invoices when user elects to pay later
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [ … ] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ { … } ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ { … } ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": { … } }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }
The updated setting that will be saved.
When set, committee members are able to manage documents in the portal
If true, the customer can choose their installment plan
If true, members have the ability to update auto renewal settings in the portal
If true, members can update directory information when updating their membership
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
The template to use for showing chapter information in the portal
In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
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
The default amount of time after a members expiration during which the are "in grace"
The fields that users can opt out of
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, chapters are able to administer their members in the portal
If set, the application generation logic will call a custom lambda function
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If true, users can opt out of the directory specifically
If selected, users will be prompted to make a donation upon checking out
If set, group membership applications are enbabled
Enable a message that shows when a person has no processes available
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
Whether members have the ability to be reinstated after termination
Enable adding flowdown memberships in KPIs
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The default 360 screen for membership editing
The default page layout for membership editing
The default page layout for membership editing
The merchant account that the store should use to receive payments
If true, a custom template is used for the chapter center
If true, a custom template is used for viewing membership information
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
When set, the membership expiration is set based on the date that the membership was paid vs ordered
Whether to use pro forma invoices when user elects to pay later
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}
https://membership.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"add_on_configuration": {
"dues_bundling": "inline",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons",
"singular_name": "string"
},
"allow_committee_members_to_manage_documents": true,
"allow_customer_to_choose_installment_plan": true,
"allow_members_to_update_auto_renewal_settings": true,
"allow_members_to_update_directory_options_in_portal": "disabled",
"bank_account_id": "string",
"bill_my_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"bill_my_parent_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"business_unit_id": "string",
"cancellation_fee_product_id": "string",
"certificate_mode": "automatically generate",
"certificate_template": "string",
"chapter_administration_settings": {
"chapter_page_layout_id": "string",
"contact_form_id": "string",
"membership_page_layout_id": "string",
"permissions": [
{
"access_saved_queries": true,
"committee_position_ids": [
"string"
],
"grace_period": 0.1,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"renew_existing_members": true,
"saved_queries": {
"0": {
"display_name": "string",
"saved_query_id": "string"
}
},
"sign_up_new_members": true,
"update_chapter_info": true,
"update_contact_info": true,
"update_membership_info": true,
"view_chapter_roster": true
}
]
},
"chapter_center_html_template": "string",
"chapter_configuration": {
"auto_assignment": "assign",
"dues_bundling": "inline",
"maximum_number_of_chapters_a_member_can_join": 1,
"members_are_required_to_join_a_chapter": true,
"plural_name": "string",
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members",
"singular_name": "string",
"update_chapter_when_contact_address_changes": true
},
"checkout_donation_options": {
"simple_checkout_donation_options": {
"allow_user_to_specify_custom_amount": true,
"donation_ask_text": "string",
"donation_denominations": [
0.1
],
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0.1
},
"type": "simple"
},
"conflicting_membership_preference": "organization",
"contact_role_permissions": [
{
"manage_membership_privileges": true,
"renew_membership": true,
"role_id": "string",
"sign_up_for_membership": true,
"update_membership_info": true
}
],
"credit_card_minimum_range_end": 0.1,
"credit_card_minimum_range_start": 0.1,
"credit_card_mode": "disabled",
"credit_card_processing_fee_mode": "charge",
"credit_card_processing_fee_options": {
"fee_percentage": 0.1,
"maximum_fee": 0.1,
"minimum_fee": 0.1,
"product_id": "string",
"prompt_sub_text": "string",
"prompt_text": "string"
},
"custom_application_generation_logic_options": {
"lambda_function_id": "string"
},
"custom_field_values": [
{
"boolean_value": true,
"custom_field_id": "string",
"file_url_value": "string",
"list_value": [
"string"
],
"numeric_value": 0.1,
"string_value": "string",
"table_value": [
{}
]
}
],
"custom_order_preprocessing_options": {
"lambda_function_id": "string"
},
"custom_order_pricing_options": {
"lambda_function_id": "string"
},
"default_grace_period": 0.1,
"directory_opt_out_fields": [
"string"
],
"disable_electronic_payment_vaulting": true,
"document_settings": {
"restrict_management_to_positions": true,
"restricted_position_ids": {
"0": "string"
}
},
"enable_add_ons": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_chapter_administration": true,
"enable_chapters": true,
"enable_custom_application_generation_logic": true,
"enable_custom_order_preprocessing": true,
"enable_custom_order_pricing": true,
"enable_directory_field_level_opt_out": true,
"enable_donations_at_checkout": true,
"enable_electronic_checks": true,
"enable_group_membership_applications": true,
"enable_id_cards": true,
"enable_no_processes_message": true,
"enable_pay_later": true,
"enable_payroll_deduction": true,
"enable_reinstatement": true,
"enable_sections": true,
"enable_split_payments": true,
"id_card_settings": {
"allow_printing_in_portal": true,
"default_id_card_template_id": "string"
},
"include_flowdown_members_in_kpis": true,
"installment_plan_options": [
{
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
],
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"membership_360_screen_id": "string",
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"merchant_account_id": "string",
"no_processes_message": "string",
"notes": "string",
"override_chapter_center_template": true,
"override_view_member_template": true,
"pay_later_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"reinstatement_options": {
"calculate_reinstatement_period_using": "expiration date",
"do_not_show_join_processes_during_reinstatement_period": true,
"give_renewal_pricing_during_reinstatement_period": true,
"reinstatement_period": 0.1
},
"restocking_fee_product_id": "string",
"section_configuration": {
"dues_bundling": "inline",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members",
"singular_name": "string"
},
"special_instructions": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"update_expiration_based_on_date_of_payment": true,
"use_pro_forma_invoices": true,
"view_member_html_template": "string"
}'The setting was updated successfully.
When set, committee members are able to manage documents in the portal
If true, the customer can choose their installment plan
If true, members have the ability to update auto renewal settings in the portal
If true, members can update directory information when updating their membership
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
The template to use for showing chapter information in the portal
In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
The fee percentage to charge for credit card processing
The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged
The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged
The misc product to use for the credit card processing
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
The default amount of time after a members expiration during which the are "in grace"
The fields that users can opt out of
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, chapters are able to administer their members in the portal
If set, the application generation logic will call a custom lambda function
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If true, users can opt out of the directory specifically
If selected, users will be prompted to make a donation upon checking out
If set, group membership applications are enbabled
Enable a message that shows when a person has no processes available
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
Whether members have the ability to be reinstated after termination
Enable adding flowdown memberships in KPIs
The additional cost of the installment plan
The installment plan that this product supports
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The default 360 screen for membership editing
The default page layout for membership editing
The default page layout for membership editing
The merchant account that the store should use to receive payments
If true, a custom template is used for the chapter center
If true, a custom template is used for viewing membership information
The ID of the product used for restocking fees
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
When set, the membership expiration is set based on the date that the membership was paid vs ordered
Whether to use pro forma invoices when user elects to pay later
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [ … ] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": { … }, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ { … } ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ { … } ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": { … } }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ { … } ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }