POST /v1/:facility_id/leads/rent_now
Create a new lead for a rent-now reservation

This API is to support the "Rent It Now" feature on the CubeSmart.com website.
It sets the rent_now attribute to true and the desired_move_in_date to the current date.

Prerequisites

• flipper_fms_rent_now must be enabled for the facility or else the request will fail
• is_reservation must be set to true
• tenant_id or tenant_attributes must be provided
• unit_id must be provided

Examples

POST /v1/54a596cb-08bf-45ac-9a1a-1a2483eb1d3c/leads
{
  "lead": {
    "is_reservation": "true",
    "tenant_attributes": {
      "first_name": "Jeff",
      "last_name": "Rentnow",
      "phone_numbers_attributes": [
        {
          "number": "5553333333",
          "sms_opt_in": "true",
          "primary": "true",
          "label": "mobile"
        }
      ],
      "mailing_address_attributes": {
        "address1": "5 Street",
        "city": "Malvern",
        "state": "PA",
        "postal": "19355"
      },
      "settings_attributes": {
        "opt_in_to_transactional_sms": "true"
      }
    },
    "unit_id": "c6a67bf8-6d7e-4e7f-a488-cda17bd03330"
  },
  "payment_method": {
    "billing_address_attributes": {
      "address1": "Address line 1",
      "city": "Melvern",
      "country": "US",
      "postal": "66510",
      "state": "AL"
    },
    "card_number": "1111111111111111",
    "card_type": "visa",
    "expiration_date": "10/24",
    "first_name": "John",
    "kind": "credit_card",
    "last_name": "Doe",
    "security_code": "123"
  }
}
201
{
  "lead": {
    "id": "0b7ec59f-ec7a-4cf1-8a05-b561831262b1",
    "bilingual_agent": false,
    "caller_first_name": null,
    "caller_last_name": null,
    "cancelled_at": null,
    "closed": false,
    "confirmation_number": "5005929959-1-9437346",
    "created_at": "2024-02-12T17:23:18.492-08:00",
    "desired_move_in_date": "2024-02-12",
    "desired_unit_size_and_price": "5x10x8 at $72.00",
    "due_at_move_in": 101.0,
    "due_monthly": 72.0,
    "extra_details": {
      "saved_cyo_options_ids": "[]",
      "snapshot_reservation_id": "30123c0e-1542-4f63-9f6b-7d1b2a078ba5",
      "move_in_from_reservation_short_url": "https://rental-center.staging.cms.cubesmart.com?companyId=7080ac59-4366-4a77-b425-79071b0b353a&facilityId=eb570f44-5dc7-4a7d-afd7-a6518ba62067&leadId=0b7ec59f-ec7a-4cf1-8a05-b561831262b1"
    },
    "facility_id": "eb570f44-5dc7-4a7d-afd7-a6518ba62067",
    "facility_time_zone": "Pacific Time (US & Canada)",
    "floor": null,
    "free_truck": false,
    "has_paid_reservation_fee": null,
    "invoiceable_fees": [
      {
        "id": "0c57a0ec-a520-4e5a-9529-8eb49ad7d4d5",
        "product_code": "ADMINFEE",
        "kind": "fee",
        "description": "Admin Fee",
        "required_at_move_in": true,
        "required_at_transfer": false,
        "amount": 29.0,
        "short_description": null,
        "show_in_sales_center": false,
        "tax_total": 0.0,
        "total": 29.0
      }
    ],
    "kind": "internet",
    "lead_action_indexes": {},
    "length_of_stay_id": null,
    "move_in_from_reservation_url": "https://rent-now.cubesmart.com/eb570f44-5dc7-4a7d-afd7-a6518ba62067/0b7ec59f-ec7a-4cf1-8a05-b561831262b1",
    "moved_in_at": null,
    "moving_labor": false,
    "moving_labor_contacted_already": false,
    "next_action_at": "2024-02-12T00:00:00.000-08:00",
    "next_lead_action": null,
    "next_lead_action_index": null,
    "origination": "reservation",
    "plant_a_tree": false,
    "quoted_rate": 72.0,
    "rate_type": "standard_rate",
    "rent_now": true,
    "reduced_price": 72.0,
    "reservation_fee_required": null,
    "reservation_window": 30,
    "reserved_at": "2024-02-12T17:23:18.235-08:00",
    "size": "5x10x8",
    "source_id": "af971b52-b3ad-40b5-93da-e0cd32d24c6f",
    "source_name": "CubeSmart: App Dev",
    "standard_rate": 72.0,
    "started_at": "2024-02-12T17:23:18.492-08:00",
    "status": "reserved",
    "tenant_id": "199670a2-cf10-4a7c-bd77-3d3078468dc8",
    "urgent": false,
    "wait_list": false,
    "wait_list_available": false,
    "within_reservation_window": true,
    "is_upgrade": null,
    "desired_unit_size_and_amenities": null,
    "tenant": {
      "id": "199670a2-cf10-4a7c-bd77-3d3078468dc8",
      "account_number": 5005929959,
      "first_name": "Jeff",
      "last_name": "Rentnow",
      "middle_initial": null,
      "email": null,
      "tax_exempt": false,
      "is_military": false,
      "is_business": false,
      "business_name": null,
      "last_sign_in_at": null,
      "title": null,
      "delinquent": false,
      "current_ledger_ids": [],
      "preferences": {
        "email_invoices": true,
        "print_invoices": false,
        "charge_invoice_fee": true,
        "receive_legal_notices_by_email": null,
        "delinquency_exempt": false,
        "delinquency_docs_by_email": false,
        "delinquency_docs_by_mail": false,
        "receive_sms_for_gate_activity": false,
        "opt_in_to_marketing_emails": false,
        "opt_in_to_marketing_sms": false,
        "opt_in_to_transactional_sms": true,
        "exclude_from_insurance_auto_enroll": false,
        "exclude_from_insurance_auto_enroll_reason": null,
        "exclude_from_insurance_auto_enroll_created_by": null,
        "exclude_from_insurance_auto_enroll_on": null
      },
      "military_information": null,
      "username": null,
      "drivers_license_number": null,
      "drivers_license_state": null,
      "vehicle_license_plate_number": null,
      "vehicle_license_state": null,
      "vehicle_description": null,
      "has_tenant_portal_account": false,
      "created_at": "2024-02-12T17:23:18.166-08:00",
      "gate_24_hour_access": false,
      "active": true,
      "tenant_account_kind_name": "Standard",
      "blocked_payments": false,
      "date_of_birth": null,
      "phone_numbers": [
        {
          "id": "cf512f53-501b-4040-9c9d-1339d556849b",
          "primary": true,
          "source": null,
          "number": "+15553333333",
          "formatted_number": "(555) 333-3333",
          "extension": null,
          "label": "mobile",
          "unformatted_number": "5553333333"
        }
      ],
      "mailing_address": {
        "id": "a29fd7b4-9197-4924-9cd4-5e4a99555645",
        "address1": "5 Street",
        "address2": null,
        "city": "Malvern",
        "state": "PA",
        "postal": "19355",
        "country": "US",
        "full_address": "5 Street, Malvern, PA 19355",
        "latitude": null,
        "longitude": null,
        "time_zone_id": "America/New_York",
        "time_zone_offset": "-05:00",
        "invalid_data": false,
        "label": "Home"
      },
      "addresses": [
        {
          "id": "a29fd7b4-9197-4924-9cd4-5e4a99555645",
          "address1": "5 Street",
          "address2": null,
          "city": "Malvern",
          "state": "PA",
          "postal": "19355",
          "country": "US",
          "full_address": "5 Street, Malvern, PA 19355",
          "latitude": null,
          "longitude": null,
          "time_zone_id": "America/New_York",
          "time_zone_offset": "-05:00",
          "invalid_data": false,
          "label": "Home"
        }
      ],
      "facility_id": "eb570f44-5dc7-4a7d-afd7-a6518ba62067",
      "previous_ledger_ids": [],
      "closed_lead_ids": [],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [
        "0c3d2d41-0b8a-4478-8cfa-0429b831f429"
      ],
      "password_recovery_question_ids": []
    },
    "unit": {
      "id": "c6a67bf8-6d7e-4e7f-a488-cda17bd03330",
      "price": 72.0,
      "name": "H236",
      "description": "(HEE) - Air cooled (swamp cooled) only / Heated only, Economy Pricing, Upstairs access via elevator",
      "width": 5.0,
      "length": 10.0,
      "height": 8.0,
      "door_height": 6.0,
      "door_width": 3.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "5x10x8",
      "area": 50.0,
      "standard_rate": 72.0,
      "managed_rate": null,
      "available_for_move_in": false,
      "rentable": true,
      "status": "reserved",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": {
        "id": 60694,
        "name": "Prepped",
        "combo_code": " ",
        "facility_id": 17398,
        "created_at": "2023-11-15T15:39:45.280-08:00",
        "updated_at": "2023-11-15T15:39:45.280-08:00"
      },
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": "HEE",
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": true,
      "tiering": {
        "cross_sell_group_id": "502b7398-32ae-4f5e-8c1c-f82c517e6381",
        "descriptor": "Economy Pricing",
        "tiered_amenities": [
          "59ba10f6-4083-46aa-a588-4c70b236c584"
        ]
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "8628f2b3-2fe6-44ee-a3f7-918c7886181f",
          "name": "Air cooled (swamp cooled) only / Heated only",
          "short_code": "H",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 5
        },
        {
          "id": "41d36c49-e5cb-4909-82f9-7e2809a2884c",
          "name": "Upstairs access via elevator",
          "short_code": "E",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 21
        },
        {
          "id": "59ba10f6-4083-46aa-a588-4c70b236c584",
          "name": "Economy Pricing",
          "short_code": "E",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 85
        }
      ],
      "unit_type": {
        "id": "94385936-5500-4b12-bb14-6d4b425b80b8",
        "name": "Storage",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": [],
        "commercial": false
      },
      "unit_group_id": "0c647fd9-c3ee-4824-8fe3-d8247bf6f635"
    },
    "length_of_stay": null,
    "successful_payment_events": [],
    "caller_phone_number": null,
    "unit_amenities": [
      {
        "id": "8628f2b3-2fe6-44ee-a3f7-918c7886181f",
        "name": "Air cooled (swamp cooled) only / Heated only",
        "short_code": "H",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 5
      },
      {
        "id": "41d36c49-e5cb-4909-82f9-7e2809a2884c",
        "name": "Upstairs access via elevator",
        "short_code": "E",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 21
      },
      {
        "id": "59ba10f6-4083-46aa-a588-4c70b236c584",
        "name": "Economy Pricing",
        "short_code": "E",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 85
      }
    ],
    "current_user": null,
    "unit_type": {
      "id": "94385936-5500-4b12-bb14-6d4b425b80b8",
      "name": "Storage",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": [],
      "commercial": false
    },
    "close_reason": null,
    "discount_plans": [],
    "lead_contents": [],
    "unit_group": {
      "id": "0c647fd9-c3ee-4824-8fe3-d8247bf6f635",
      "price": 72.0,
      "group_key": "5x10x8 - $72.00 - 2 - [5 - 21 - 85]",
      "name": "5x10x8 - $72.00 - 2 - [5 - 21 - 85]",
      "available_units_count": 0,
      "total_units_count": 50,
      "total_non_excluded_units_count": 50,
      "size": "5x10x8",
      "standard_rate": 72.0,
      "floor": null,
      "reduced_price": 54.0,
      "cyo_reduced_prices": {},
      "occupancy_percent": 98.0,
      "area": 50.0,
      "length": 10.0,
      "width": 5.0,
      "height": 8.0,
      "due_at_move_in": 83.0,
      "due_at_move_in_without_fees": 54.0,
      "due_monthly": 54.0,
      "attribute_description": "HEE",
      "description": "(HEE) - Air cooled (swamp cooled) only / Heated only, Economy Pricing, Upstairs access via elevator",
      "invoiceable_fees": [
        {
          "id": "0c57a0ec-a520-4e5a-9529-8eb49ad7d4d5",
          "product_code": "ADMINFEE",
          "kind": "fee",
          "description": "Admin Fee",
          "required_at_move_in": true,
          "required_at_transfer": false,
          "amount": 29.0,
          "short_description": null,
          "show_in_sales_center": false,
          "tax_total": 0.0,
          "total": 29.0
        }
      ],
      "average_rent": 106.53,
      "active_rate_type": "standard_rate",
      "scheduled_move_outs": [],
      "managed_rate": null,
      "reservation_fee": null,
      "tiering": {
        "cross_sell_group_id": "502b7398-32ae-4f5e-8c1c-f82c517e6381",
        "descriptor": "Economy Pricing",
        "justification": null,
        "tiered_amenities": [
          "59ba10f6-4083-46aa-a588-4c70b236c584"
        ]
      },
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "8628f2b3-2fe6-44ee-a3f7-918c7886181f",
          "name": "Air cooled (swamp cooled) only / Heated only",
          "short_code": "H",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 5
        },
        {
          "id": "41d36c49-e5cb-4909-82f9-7e2809a2884c",
          "name": "Upstairs access via elevator",
          "short_code": "E",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 21
        },
        {
          "id": "59ba10f6-4083-46aa-a588-4c70b236c584",
          "name": "Economy Pricing",
          "short_code": "E",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 85
        }
      ],
      "unit_type": {
        "id": "94385936-5500-4b12-bb14-6d4b425b80b8",
        "name": "Storage",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": [],
        "commercial": false
      },
      "discount_plans": [],
      "channel_rate_ids": [],
      "available_upgrade_to_unit_groups": []
    },
    "created_by": {
      "id": "af971b52-b3ad-40b5-93da-e0cd32d24c6f",
      "name": "CubeSmart: App Dev",
      "type": "Source"
    },
    "channel_id": "af971b52-b3ad-40b5-93da-e0cd32d24c6f",
    "confirmation_email": null
  },
  "meta": {
    "status_code": 201,
    "status_message": "Created",
    "status_cat": "https://http.cat/201",
    "request_method": "POST",
    "request_id": "88f932c8-5c86-42b6-90ef-75d356109e68",
    "parameters": {
      "lead": {
        "is_reservation": "true",
        "tenant_attributes": {
          "first_name": "Jeff",
          "last_name": "Rentnow",
          "phone_numbers_attributes": [
            {
              "number": "5553333333",
              "sms_opt_in": "true",
              "primary": "true",
              "label": "mobile"
            }
          ],
          "mailing_address_attributes": {
            "address1": "5 Street",
            "city": "Malvern",
            "state": "PA",
            "postal": "19355"
          },
          "settings_attributes": {
            "opt_in_to_transactional_sms": "true"
          }
        },
        "unit_id": "c6a67bf8-6d7e-4e7f-a488-cda17bd03330"
      },
      "payment_method": {
        "billing_address_attributes": {
          "address1": "Address line 1",
          "city": "Melvern",
          "country": "US",
          "postal": "66510",
          "state": "AL"
        },
        "card_number": "[FILTERED]",
        "card_type": "visa",
        "expiration_date": "10/24",
        "first_name": "John",
        "kind": "credit_card",
        "last_name": "Doe",
        "security_code": "[FILTERED]"
      },
      "facility_id": "eb570f44-5dc7-4a7d-afd7-a6518ba62067"
    }
  }
}

Params