Ordergroove Developer Documentation

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070000693",
  "payment": "443ddf72094711e9a5afbc764e1043b0",
  "shipping_address": "394aee16d61611e88b4abc764e1043b0",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "raw_subscription_type": "replenishment",
  "components": [],
  "extra_data": {},
  "public_id": "607daa2accc811e88516bc764e106cf4",
  "product_attribute": null,
  "quantity": 2,
  "price": null,
  "frequency_days": 180,
  "reminder_days": 10,
  "every": 6,
  "every_period": 3,
  "start_date": "2018-12-27",
  "cancelled": null,
  "cancel_reason": null,
  "cancel_reason_code": null,
  "iteration": null,
  "sequence": null,
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "customer_rep": null,
  "club": null,
  "created": "2018-10-10 15:09:21",
  "updated": "2019-04-02 17:27:53",
  "live": true,
  "external_id": null,
  "currency_code": "USD"
}

Updates the quantity of a subscription.

Rejects prepaid subscriptions with 400.

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

Request

This endpoint expects an object.

quantityintegerOptional

Number of items

Response

200

customerstringOptional

merchantstringOptional

productstringOptional

paymentstringOptional

shipping_addressstring or nullOptional

offerstring or nullOptional

offer_profile_public_idstring or nullOptional

Public ID of the offer profile the subscription's offer belongs to. Returned only by List and Retrieve.

subscription_typestringOptional

raw_subscription_typestringOptional

The subscription type as stored. subscription_type reports IU replenishment and CSA replenishment as replenishment; this field keeps the original value.

componentslist of objectsOptional

Bundle components. Each has product; public_id and quantity are returned only when the merchant has multi-item bundles enabled.

extra_dataobjectOptional

Custom data stored on the subscription, as a JSON object. {} when the subscription has none. Ordergroove and your integrations can store their own keys here.

public_idstringOptional

product_attributeinteger or nullOptional

quantityintegerOptional

pricestring or nullOptional

frequency_daysintegerOptional

reminder_daysintegerOptional

everyintegerOptional

every_periodintegerOptional

start_datestringOptional

cancelledstring or nullOptional

cancel_reasonstring or nullOptional

cancel_reason_codeinteger or nullOptional

iterationinteger or nullOptional

sequenceinteger or nullOptional

session_idstringOptional

merchant_order_idstring or nullOptional

customer_repinteger or nullOptional

clubinteger or nullOptional

createdstringOptional

updatedstringOptional

livebooleanOptional

external_idstring or nullOptional

currency_codestring or nullOptional

Three-letter ISO currency code.

queued_actionslist of objectsOptional

Pending queued actions, in order. Returned only when the merchant has queued actions enabled; empty when the subscription isn’t live or has none.

prepaid_subscription_contextobject or nullOptional

Prepaid details. Returned only when the merchant has prepaid subscriptions enabled; null when this subscription isn’t prepaid.

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

400

Bad Request Error

403

Forbidden Error

404

Not Found Error