Update Prepaid Subscription
Changes a prepaid subscription’s orders_remaining, orders_per_billing or renewal_behavior at any point in its lifecycle.
The Application API Scope can change all three. The Storefront API Scope can change only renewal_behavior; sending orders_per_billing or orders_remaining returns 403.
After the update, if prepaid_orders_remaining is 0, a renewal_behavior of cancel cancels the subscription (live becomes false) and removes it from open orders, and downgrade converts it to a pay-as-you-go subscription.
Authentication
Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.
Path parameters
Request
Response
The subscription type as stored. subscription_type reports IU replenishment and CSA replenishment as replenishment; this field keeps the original value.
Bundle components. Each has product; public_id and quantity are returned only when the merchant has multi-item bundles enabled.
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.
Three-letter ISO currency code.
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 details. Returned only when the merchant has prepaid subscriptions enabled; null when this subscription isn’t prepaid.
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.