Upgrade Subscription To Prepaid

patch https://restapi.ordergroove.com/subscriptions/{subscription_id}/upgrade_to_prepaid/

This endpoint will allow you to upgrade a pay-as-you-go subscription to a prepaid subscription

🔐
Authentication
✔️ Application API Scope
✔️ Storefront API Scope

Validation

This operation can only be called on subscriptions that are associated with a product that is prepaid eligible. Attempting to call this mutation on a subscription that is not associated with a prepaid-eligible product will result in a 400.

Side-Effects

After upgrade, the prepaid subscription will have 0 orders remaining. As a result, the customer will be charged to “renew” the prepaid subscription at the time of their next order being placed. This allows this upgrade flow to be called directly from the customer SMI without granting the customer free fulfillments they have not yet paid for.

Responses

Language


xxxxxxxxxx
10
1
curl --request PATCH \
2
     --url https://restapi.ordergroove.com/subscriptions/subscription_id/upgrade_to_prepaid/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "renewal_behavior": "autorenew",
8
  "offer": "live"
9
}
10
'

Choose an example:

application/json

🔐Authentication

Validation

Side-Effects

200200

400400

🔐
Authentication