REST RPC APISubscriptions

Create in Order

View as Markdown

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.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
merchantstringRequired
Merchant ID
customerstringRequired
Customer ID
productstringRequired
Product ID
offerstringRequired
Offer ID
orderstringRequired
Order ID
session_idstringRequired

Session ID, obtained from og_session_id cookie

paymentstringRequired
Payment record ID
shipping_addressstringRequired
Shipping address record ID
quantityintegerRequired
Number of items
everyintegerRequired
Number of periods
every_periodintegerRequired
Type of period
pricestringOptional
Price of subscription. To be used with Price Lock.
extra_datastringOptionalformat: "json"

{“cat_name”: “Charlie”}

componentslist of objectsOptional

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

Response

200
public_idstring
product_attributeany
pricestring
frequency_daysintegerDefaults to 0
reminder_daysintegerDefaults to 0
start_datestring
cancelledany
cancel_reason_codestring
cancel_reasonstring
merchant_order_idstring
subscription_typestring
componentslist of objects
createdstring
updatedstring
extra_datastring
livestring

Errors

403
Forbidden Error