Subscription Config
Field descriptions
-
field_overrides
– Allows you to control which property type options appear on the subscription dashboard by removing or excluding specific types.
Available Property Types:single_family_home
– A standalone residential property.townhouse
– A multi-floor home that shares one or more walls with adjacent properties.condo
– A residential unit within a larger building or complex, where the buyer owns the interior space but shares common areas.multi_family
– A building that contains two or more separate housing units, such as a duplex or apartment complex.manufactured_home
– A factory-built home constructed on a permanent chassis and transported to its site.
-
mortgage_terms
– Allows you to remove or exclude specific mortgage programs (e.g., 15-year fixed, ARM products) from being displayed on the subscription dashboard.
Available Mortgage Terms:- 30yr Fixed
- 20yr Fixed
- 15yr Fixed
- 10y/6m ARM
- 7y/6m ARM
- 5y/6m ARM
- 3y/6m ARM
-
sort_by_default
– Sets the default sort order of rate results.
Options include:relevance
– Based on system-calculated match to target scenario.low_rate
– Sort by lowest interest rate.low_apr
– Sort by lowest annual percentage rate.low_monthly_payment
– Sort by lowest monthly payment.low_upfront_costs
– Sort by lowest upfront closing costs.
-
defaults
– Change the defaults on the rate table. Bold is the default.loan_type
– conventional, fha, va, usda, armdown_payment
- 90000 (numeric)list_price
- 450000 (numeric)lock_period
- 30, 45, 60property_type
- single_family_home, townhome, condominium, multi_tenant_home, manufactured_homeresidency_type
- primary_home, second_home, rental_home
Updated 8 days ago
Did this page help you?