GET /v1/:facility_id/discount_plans/:id
Show a particular discount plan

Allowed values for kind

• always - always
• limited - a number of months

Allowed values for discount_type

• amount - $ off
• fixed - fixed price
• none - no discount
• percent - % off
• variable - variable

Examples

GET /v1/1647bf35-0777-4588-8be5-051dfd6b4a43/discount_plans/8e57f290-d077-47d3-a5e7-e255d943f05b
200
{
  "discount_plan": {
    "id": "8e57f290-d077-47d3-a5e7-e255d943f05b",
    "name": "PLAN6",
    "description": "It's so descriptive #6",
    "public_description": null,
    "availability_text": "9/15/2023",
    "requirements_text": "",
    "kind": "limited",
    "min_occupancy_required": false,
    "min_occupancy_months": null,
    "prepay_required": false,
    "prepay_months": null,
    "start_date": "2023-09-15",
    "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": "a97c5fe2-7b87-413a-a6ca-89dccc7ccf47",
        "discount_type": "amount",
        "month_number": 1,
        "amount": 10.0,
        "minimum_amount": null,
        "maximum_amount": null
      },
      {
        "id": "2a1d1931-10af-405d-9d68-b2ad93a3ed2e",
        "discount_type": "percent",
        "month_number": 2,
        "amount": 10.0,
        "minimum_amount": null,
        "maximum_amount": null
      },
      {
        "id": "8e4ad9ea-5353-4d5e-9f7d-3eb37b4f0e28",
        "discount_type": "none",
        "month_number": 3,
        "amount": 0.0,
        "minimum_amount": null,
        "maximum_amount": null
      },
      {
        "id": "a35f8927-f58d-4c4b-9fac-a6777ac0bb1f",
        "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": "a97c5fe2-7b87-413a-a6ca-89dccc7ccf47",
    "facility_ids": [
      "1647bf35-0777-4588-8be5-051dfd6b4a43"
    ]
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "1647bf35-0777-4588-8be5-051dfd6b4a43",
      "id": "8e57f290-d077-47d3-a5e7-e255d943f05b",
      "discount_plan": {}
    }
  }
}