API Reference

Create in Order

post
https://restapi.ordergroove.com/subscriptions/iu/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Merchant ID

string
required

Customer ID

string
required

Product ID

string

Price of subscription. To be used with Price Lock.

string
required

Offer ID

string
required

Order ID

string
required

Session ID, obtained from og_session_id cookie

string
required

Payment record ID

string
required

Shipping address record ID

int32
required

Number of items

int32
required

Number of periods

int32
required

Type of period

json

{"cat_name": "Charlie"}

components
array of objects

Multi Item Bundle components: [{"product":"public_id_abc", "quantity": 2}], Legacy Bundle components: [{"product":"public_id_abc"}]

components
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 3 months ago