Discount Plans (Facility Level)
Configured promotional plans

Discussion

Discount plans are a systematic way to define a discount or series of discounts that can be given to a tenant. A discount may be continuous (i.e. recurs every month) or it may have a limited duration (i.e. 3 months).

>>>

GET /v1/:facility_id/discount_plans
Show configured discount plans

Examples

GET /v1/267bb8e9-ad0b-4a6f-8051-01ab3b81d937/discount_plans
200
{
  "discount_plans": [
    {
      "id": "6991606c-2ad9-49cf-9557-3b7db0f27ddb",
      "name": "PLAN4",
      "description": "It's so descriptive #4",
      "public_description": null,
      "availability_text": "9/15/2023",
      "requirements_text": "",
      "kind": "always",
      "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": "895c658b-6d6f-4466-84bf-7389338bf1d2",
          "discount_type": "percent",
          "month_number": 1,
          "amount": 10.0,
          "minimum_amount": null,
          "maximum_amount": null
        }
      ],
      "discount_plan_controls": [],
      "api_association_ids": [
        "377b1d21-a2eb-47fd-ada2-046556c318c7"
      ],
      "client_applications": [
        {
          "id": "b8fe0bc6-074e-484e-a849-2de37c80f4ea",
          "name": "Test App",
          "channel_rates_on": false,
          "internal": false
        }
      ],
      "always_discount_plan_discount_id": "895c658b-6d6f-4466-84bf-7389338bf1d2",
      "facility_ids": [
        "267bb8e9-ad0b-4a6f-8051-01ab3b81d937"
      ]
    },
    {
      "id": "f30ec7d4-5099-445f-9d02-f88ee9e26c8d",
      "name": "PLAN5",
      "description": "It's so descriptive #5",
      "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": "04af6d93-34e0-424a-861c-96cf9fe0444d",
          "discount_type": "amount",
          "month_number": 1,
          "amount": 10.0,
          "minimum_amount": null,
          "maximum_amount": null
        },
        {
          "id": "fc9c606d-3937-4aeb-b4dc-a5704b02de34",
          "discount_type": "percent",
          "month_number": 2,
          "amount": 10.0,
          "minimum_amount": null,
          "maximum_amount": null
        },
        {
          "id": "ea0f8d7d-a22f-4116-89e9-46b3b7505549",
          "discount_type": "none",
          "month_number": 3,
          "amount": 0.0,
          "minimum_amount": null,
          "maximum_amount": null
        },
        {
          "id": "35f5a3dd-c322-4002-9895-ca560520a2c0",
          "discount_type": "fixed",
          "month_number": 4,
          "amount": 0.0,
          "minimum_amount": null,
          "maximum_amount": null
        }
      ],
      "discount_plan_controls": [],
      "api_association_ids": [
        "377b1d21-a2eb-47fd-ada2-046556c318c7"
      ],
      "client_applications": [
        {
          "id": "b8fe0bc6-074e-484e-a849-2de37c80f4ea",
          "name": "Test App",
          "channel_rates_on": false,
          "internal": false
        }
      ],
      "always_discount_plan_discount_id": "04af6d93-34e0-424a-861c-96cf9fe0444d",
      "facility_ids": [
        "267bb8e9-ad0b-4a6f-8051-01ab3b81d937"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 2,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "267bb8e9-ad0b-4a6f-8051-01ab3b81d937",
      "discount_plan": {}
    }
  }
}
>>>

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": {}
    }
  }
}