The field kind
has these possible values: limited
(meaning a number of months), always
(meaning always)
The field discount_type
has these possible values: none
(meaning no discount), amount
(meaning $ off), percent
(meaning % off), fixed
(meaning fixed price), variable
(meaning variable)
GET /v1/a8d1d612-c800-470d-a83b-0af8ababaa78/discount_plans/c273abd9-d537-47b0-8861-dc26cecf165a 200 { "discount_plan": { "id": "c273abd9-d537-47b0-8861-dc26cecf165a", "name": "PLAN5", "description": "It's so descriptive #5", "public_description": null, "availability_text": "9/12/2022", "requirements_text": "", "kind": "limited", "min_occupancy_required": false, "min_occupancy_months": null, "prepay_required": false, "prepay_months": null, "start_date": "2022-09-12", "end_date": null, "auto_apply": false, "promotion_type": "promotion", "deleted": false, "turned_on": true, "available_for_all_facilities": true, "round_to_nearest": null, "hide_from_website": false, "move_in_only": false, "tenant_account_kind_id": null, "existing_tenant_only": false, "priority": null, "role_permission": null, "choose_your_own_promo": false, "discount_plan_discounts": [ { "id": "7906269d-a9ee-43b0-aff1-207f9c0deff3", "discount_type": "amount", "month_number": 1, "amount": 10.0, "minimum_amount": null, "maximum_amount": null }, { "id": "7823fb0c-877b-4664-95d3-ae10bcb1d190", "discount_type": "percent", "month_number": 2, "amount": 10.0, "minimum_amount": null, "maximum_amount": null }, { "id": "e097fd72-b7eb-438e-8572-202ca481bcc7", "discount_type": "none", "month_number": 3, "amount": 0.0, "minimum_amount": null, "maximum_amount": null }, { "id": "080aa79d-2ab3-4735-8acd-bf4702c4539f", "discount_type": "fixed", "month_number": 4, "amount": 0.0, "minimum_amount": null, "maximum_amount": null } ], "discount_plan_controls": [], "api_association_ids": [], "client_applications": [], "always_discount_plan_discount_id": "7906269d-a9ee-43b0-aff1-207f9c0deff3", "facility_ids": [ "a8d1d612-c800-470d-a83b-0af8ababaa78" ] }, "meta": { "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "GET", "request_id": null, "parameters": { "facility_id": "a8d1d612-c800-470d-a83b-0af8ababaa78", "id": "c273abd9-d537-47b0-8861-dc26cecf165a" } } }