ORordergroove

Retrieve

Returns information about a single subscription by its unique identifier.

get/subscriptions/{subscription_id}/

Request

  • Base URL
    https://restapi.ordergroove.com
  • Auth
    • none
    • or API key in header x-api-key

Path parameters

subscription_idstring required

unique subscription ID

Response

200

customerstring
merchantstring
productstring
paymentstring
shipping_addressstring
offerstring
offer_profile_public_idstring
subscription_typestring
componentsobject[]
extra_dataobject
public_idstring
product_attributeunknown
quantityinteger
priceunknown
frequency_daysinteger
reminder_daysinteger
everyinteger
every_periodinteger
start_datestring
cancelledunknown
cancel_reasonunknown
cancel_reason_codeunknown
iterationunknown
sequenceunknown
session_idstring
merchant_order_idstring
customer_repunknown
clubunknown
createdstring
updatedstring
liveboolean

Example response

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070067689",
  "payment": "443ddf72094711e9a5afbc764e1043b0",
  "shipping_address": "394aee16d61611e88b4abc764e1043b0",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "public_id": "0ff0f88accc511e8b6c0bc764e106cf4",
  "quantity": 4,
  "frequency_days": 120,
  "reminder_days": 10,
  "every": 4,
  "every_period": 3,
  "start_date": "2018-12-27",
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "created": "2018-10-10 14:45:38",
  "updated": "2019-01-17 12:09:23",
  "live": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.