Ordergroove Developer Documentation

curl -X PATCH https://restapi.ordergroove.com/subscriptions/subscription_id/change_renewal_behavior/ \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "renewal_behavior": "autorenew"
}'

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070000693",
  "payment": "070001bc02fd11e99542bc764e1043b0",
  "shipping_address": "66c25cd0564011e9abc5bc764e107990",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "raw_subscription_type": "replenishment",
  "components": [],
  "extra_data": {
    "shopify_contract_id": "gid://shopify/SubscriptionContract/2287823"
  },
  "public_id": "607daa2accc811e88516bc764e106cf4",
  "quantity": 1,
  "price": null,
  "frequency_days": 30,
  "reminder_days": 4,
  "every": 1,
  "every_period": 3,
  "start_date": "2023-05-30",
  "cancelled": null,
  "cancel_reason": null,
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "#1144",
  "created": "2023-05-30 13:20:41",
  "updated": "2023-10-03 10:22:11",
  "live": true,
  "external_id": "2287823",
  "cancel_reason_code": null,
  "customer_rep": null,
  "queued_actions": [],
  "prepaid_subscription_context": {
    "prepaid_orders_remaining": 4,
    "prepaid_orders_per_billing": 6,
    "renewal_behavior": "autorenew"
  }
}

Sets a prepaid subscription’s renewal_behavior to autorenew, cancel or downgrade. See Managing Prepaid Renewal Behaviors for what each one does.

Returns 400 when the merchant doesn’t have prepaid subscriptions enabled, the subscription isn’t prepaid or isn’t live, or renewal_behavior is missing or invalid. If prepaid_orders_remaining is 0, cancel cancels the subscription and downgrade converts it to pay-as-you-go right away.

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.

renewal_behaviorenumRequired

Allowed values:

Response

200

customerstringOptional

merchantstringOptional

productstringOptional

paymentstringOptional

shipping_addressstringOptional

offerstringOptional

subscription_typestringOptional

raw_subscription_typestringOptional

componentslist of objectsOptional

extra_dataobjectOptional

public_idstringOptional

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

iterationanyOptional

sequenceanyOptional

session_idstringOptional

merchant_order_idstringOptional

createdstringOptional

updatedstringOptional

livebooleanOptionalDefaults to true

external_idstringOptional

product_attributeanyOptional

cancel_reason_codeinteger or nullOptional

customer_repinteger or nullOptional

clubanyOptional

queued_actionslist of objectsOptional

prepaid_subscription_contextobjectOptional

Errors

400

Bad Request Error