Ordergroove Developer Documentation

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

Returns information about a single subscription by its unique identifier.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

subscription_idstringRequired

unique subscription ID

Response

200

customerstringOptional

merchantstringOptional

productstringOptional

paymentstringOptional

shipping_addressstringOptional

offerstringOptional

offer_profile_public_idstringOptional

subscription_typestringOptional

componentslist of objectsOptional

extra_dataobjectOptional

public_idstringOptional

product_attributeanyOptional

quantityintegerOptionalDefaults to 0

pricestring or nullOptional

frequency_daysintegerOptionalDefaults to 0

reminder_daysintegerOptionalDefaults to 0

everyintegerOptionalDefaults to 0

every_periodintegerOptionalDefaults to 0

start_datestringOptional

cancelledstring or nullOptional

cancel_reasonstring or nullOptional

cancel_reason_codeinteger or nullOptional

iterationanyOptional

sequenceanyOptional

session_idstringOptional

merchant_order_idstringOptional

customer_repinteger or nullOptional

clubanyOptional

createdstringOptional

updatedstringOptional

livebooleanOptionalDefaults to true

granteeslist of objectsOptional

List of grantees associated with the subscription. Omitted if the subscription has no grantees.

free_trial_subscription_contextobjectOptional

Present only if the subscription has a free trial context (i.e. it was created for a product with a free trial configured); omitted otherwise.

Errors

403

Forbidden Error

404

Not Found Error