Place Subscription Order

Complete the checkout flow to create subscription orders for your customers.

Overview

After customers select a plan and version, use the checkout endpoints to apply discounts, calculate totals, and place the order. The order will be created in pending status, waiting for payment confirmation.

Endpoints: Place Order

Checkout Flow

Apply Discounts (Optional)

Use these endpoints to calculate order totals with discounts:

Apply Voucher: Check voucher code validity and discount

Redeem Wallet: Apply wallet balance (requires wallet enabled)

Get Discount: Combines voucher + wallet in one call

All return the final price breakdown before placing order.

Prepare Order Payload

Build the order request with:

Plan version ID

Selected meal options and dates

Delivery/pickup details

Customer location

Discount codes (if applied)

Place Order

Submit the order to create a pending order awaiting payment confirmation.

Handle Payment

After order is placed:

Option A (Techrar Pay): Receive webhook when payment completes

See Order Payment for details.

Important Headers

All checkout endpoints require these headers:

Critical

city-id must match the city used when fetching plans

Order Payload Structure

Delivery Order Example

Pickup Prder Example

{
  "voucher": "WELCOME10",
  "notes": "Ring doorbell",
  "delivery_window_id": 12,
  "location": {
    "id": 9989,
    "is_corporate_location": false
  },
  "cart_items": [
    {
      "subscription": {
        "plan_id": 2455, // Plan Version ID
        "dates": [
          {
            "date": "2025-11-25",
            "options": [101, 102, 103]
          },
          {
            "date": "2025-11-26",
            "options": [104, 105, 106]
          }
        ],
        "is_paused": false,
        "primary_location_id": 9989,
        "secondary_location_id": 9989,
        "notes": "No spicy food"
      },
      "quantity": 1,
      "is_subscription": true
    }
  ],
  "is_subscription": true,
  "is_redeeming": false,
  "channel_app_id": 44
}

Key Payload Fields

Required for All Orders

Field	Type	Description
`cart_items`	array	Order items (always 1 subscription)
`is_subscription`	boolean	Always `true` for subscriptions

Subscription Details

Field	Type	Description
`plan_id`	integer	Plan version ID (from selected version)
`dates`	array	Meal selections per date
`quantity`	integer	Always `1` for subscriptions
`is_paused`	boolean	Start subscription paused? (usually `false`)

Dates & Meal Options

"dates": [
  {
    "date": "2025-11-25",
    "options": [101, 102, 103]
  }
]

date: Delivery date in "YYYY-MM-DD" format (from Plans & Versionsdates array)

options: Meal option IDs for that date (from Plans & Versions masters)

Auto-Select Coming Soon

We're adding auto_select feature where Techrar automatically selects meal options, eliminating the need to send dates array.

Delivery-Specific

Field	Type	Description
`delivery_window_id`	integer	Time slot ID (from provider's `delivery_windows`)
`location.id`	integer	Customer location ID
`primary_location_id`	integer	Same as `location.id`
`secondary_location_id`	integer	Same as `location.id` (optional alternative location)
`is_corporate_location`	boolean	Always `false`

Pickup-Specific

Field	Type	Description
`is_pickup`	boolean	Set to `true`
`pickup_branch_id`	integer	Branch ID (from provider's `pickup_branches`)

Optional Fields

Field	Type	Description
`voucher`	string	Voucher code to apply
`is_redeeming`	boolean	Redeem wallet balance?
`notes`	string	Order notes
`secondary_mobile_number`	string	Alternative contact number

Building Dates Array

The dates array must match the subscription duration:

Step 1: Get Available Dates

From Plan Details response, use the dates array:

"dates": ["2025-11-25", "2025-11-26", "2025-11-27"]

Step 2: Get Meal Options

From Plan Details response, use masters to find options for each date:

"masters": [
  {
    "day": "2025-11-25",
    "plan_categories": [
      {
        "name_en": "Breakfast",
        "options": [
          {"id": 101, "product": {...}},
          {"id": 102, "product": {...}}
        ]
      }
    ]
  }
]

Step 3: Build Dates Payload

For each date, customer selects options:

"dates": [
  {
    "date": "2025-11-25",
    "options": [101, 205, 308]  // Breakfast, Lunch, Dinner
  },
  {
    "date": "2025-11-26",
    "options": [102, 206, 309]
  }
]

Discounts & Wallet

Voucher Codes

Add voucher field with code:

{
  "voucher": "WELCOME10",
  ...
}

Wallet Redemption

Enable wallet redemption:

{
  "is_redeeming": true,
  ...
}

Wallet must be enabled in your App Config. See Customer Profile

Check Discount Before Placing Order

Call Get Discount endpoint with same payload to see final price:

Returns price breakdown with discounts applied.

Response

After placing order, you'll receive a full order object.
Go to the next step to handle Order Payment

Common Issues

Wrong app-id Header

Problem: Sending sales channel app ID instead of provider app ID

Solution: Use provider's ID from plan's restaurant.id field

Invalid Dates

Problem: Dates don't match plan's available dates

Solution: Use dates from plan details dates array only

Missing Meal Options

Problem: Not enough options selected for some dates

Solution: Validate option count matches daily_num_of_items

Location Not Found

Problem: Invalid location ID

Solution: Verify location was created using Customer Location steps

Place Subscription Order

Overview#

Checkout Flow#

Important Headers#

Order Payload Structure#

Key Payload Fields#

Required for All Orders#

Subscription Details#

Dates & Meal Options#

Delivery-Specific#

Pickup-Specific#

Optional Fields#

Building Dates Array#

Step 1: Get Available Dates#

Step 2: Get Meal Options#

Step 3: Build Dates Payload#

Discounts & Wallet#

Voucher Codes#

Wallet Redemption#

Check Discount Before Placing Order#

Response#

Common Issues#

Wrong app-id Header#

Invalid Dates#

Missing Meal Options#

Location Not Found#

Overview

Checkout Flow

Important Headers

Order Payload Structure

Key Payload Fields

Required for All Orders

Subscription Details

Dates & Meal Options

Delivery-Specific

Pickup-Specific

Optional Fields

Building Dates Array

Step 1: Get Available Dates

Step 2: Get Meal Options

Step 3: Build Dates Payload

Discounts & Wallet

Voucher Codes

Wallet Redemption

Check Discount Before Placing Order

Response

Common Issues

Wrong app-id Header

Invalid Dates

Missing Meal Options

Location Not Found