---
title: "Create in Order"
method: POST
path: "/subscriptions/iu/"
---

# Create in Order

`POST /subscriptions/iu/`

## Request

- Base URL: `https://restapi.ordergroove.com`
- URL: `https://restapi.ordergroove.com/subscriptions/iu/`
- Auth: one of:
  - none
  - API key in header `x-api-key`

Creates a subscription with its first shipment in an existing order (dictated by the 'order' field in the request). This will be tracked by OrderGroove as an 'Impulse Upsell' order.

## Request body

- object
  - `merchant` string, required: Merchant ID
  - `customer` string, required: Customer ID
  - `product` string, required: Product ID
  - `price` string: Price of subscription. To be used with Price Lock.
  - `offer` string, required: Offer ID
  - `order` string, required: Order ID
  - `session_id` string, required: Session ID, obtained from og_session_id cookie
  - `payment` string, required: Payment record ID
  - `shipping_address` string, required: Shipping address record ID
  - `quantity` integer, required: Number of items
  - `every` integer, required: Number of periods
  - `every_period` integer, required: Type of period
  - `extra_data` string, json: {"cat_name": "Charlie"}
  - `components` object[]: Multi Item Bundle components: [{"product":"public_id_abc", "quantity": 2}], Legacy Bundle components: [{"product":"public_id_abc"}]
    - `product` string, required: The id of the product that is being added to the bundle
    - `quantity` integer, required: The quantity of the product being added

## Response `200`

200

- object
  - `public_id` string
  - `product_attribute` unknown
  - `price` string
  - `frequency_days` integer
  - `reminder_days` integer
  - `start_date` string
  - `cancelled` unknown
  - `cancel_reason_code` string
  - `cancel_reason` string
  - `merchant_order_id` string
  - `subscription_type` string
  - `components` object[]
    - `product` string
  - `created` string
  - `updated` string
  - `extra_data` string
  - `live` string

## Other responses

- `400`: 400
- `403`: 403

---

[API](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc.md) - [All operations](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc/llms.txt) - [OpenAPI document](https://skmtc.dev/ordergroove/apis/ordergroove-restrpc/revisions/ba97e740d08c?raw)
