LIliftforward
Promotions

Show Promotions

Returns a list of promotions with subscription plans available for the provided items.

The request body must include at least 1 item with its SKU. Optionally, quantity, unit_sale_price and residual value category can be provided for each item. When optional values are not provided, defaults from the known product are used. If any SKUs are not recognized and no unit_sale_price is provided for that item, a 422 error is returned as the item's price can not be calculated. If a shipping_fee is provided, it will be included in the pricing calculations in the response. Each available subscription plan includes an items array with per-request-line financing figures. Rounded per-item payments may differ from the plan-level installment_payment by cents; shipping_fee is not allocated across items.

post/promotions

Request

  • Base URL
    https://api.liftforward.com
  • Auth
    API key in header Api-Key

Request body

shipping_feenumber float

A flat shipping fee for the entire order to include in pricing calculations.

Example request

{
  "items": [
    {
      "sku": "SKU12345",
      "quantity": 1,
      "unit_sale_price": 900,
      "residual_value_category": "laptops"
    }
  ],
  "shipping_fee": 5.99
}

Response

Show Promotions

Example response

{
  "promotions": [
    {
      "promotion_code": "MERCHANT-UPGRADE-01",
      "title": "Smart Upgrade",
      "type": "payment",
      "category": "upgrade",
      "description": "About Smart Upgrade...",
      "available_subscription_plans": [
        {
          "subscription_plan_id": "standard-plan-30",
          "program_code": "subscription-us",
          "plan_code": "standard",
          "plan_name": "Standard Plan",
          "plan_subtitle": "This is the basic plan.",
          "plan_summary": "Total financed amount when you upgrade is $2,090 and includes 25 months of payments. T&Cs, fees, charges & exclusions apply.",
          "financing_plan_type": "financing",
          "installment_count": 30,
          "installment_count_to_trade_in": 24,
          "unit_installment_payment": 9.91,
          "installment_payment": 9.91,
          "total_installment_payment": 9.91,
          "total_over_term": 2090,
          "installment_service_fee": 9.95,
          "residual_value": 29.99,
          "total_residual_value": 29.99,
          "total_payment_to_buy_out": 2030,
          "total_payment_to_trade_in": 2030,
          "currency": "USD",
          "items": [
            {
              "sku": "SKU12345",
              "quantity": 2,
              "unit_sale_price": 49.99,
              "unit_amount_financed": 49.99,
              "unit_installment_payment": 2.09,
              "total_installment_payment": 4.17,
              "total_residual_value": 9.65
            }
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 8 revisions of this API.