---
title: "Upgrade Subscription To Prepaid"
method: PATCH
path: "/subscriptions/{subscription_id}/upgrade_to_prepaid/"
---

# Upgrade Subscription To Prepaid

`PATCH /subscriptions/{subscription_id}/upgrade_to_prepaid/`

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

## Path parameters

- `subscription_id` string, required

## Request body

- object
  - `orders_per_billing` integer, required — An integer greater than 2
  - `renewal_behavior` 'autorenew' | 'cancel' | 'downgrade'
  - `offer` string — An optional field that if populated will switch which offer the subscription is associated with after upgrade. You can provide the public-id of the offer that you would like to swap the subscription to, or the string “live” which will re-associate the subscription with your currently live offer

## Response `200`

200

- object
  - `customer` string
  - `merchant` string
  - `product` string
  - `payment` string
  - `shipping_address` string
  - `offer` string
  - `subscription_type` string
  - `raw_subscription_type` string
  - `components` object[]
  - `extra_data` object
    - `shopify_contract_id` string
  - `public_id` string
  - `quantity` integer
  - `price` unknown
  - `frequency_days` integer
  - `reminder_days` integer
  - `every` integer
  - `every_period` integer
  - `start_date` string
  - `cancelled` unknown
  - `cancel_reason` unknown
  - `iteration` unknown
  - `sequence` unknown
  - `session_id` string
  - `merchant_order_id` string
  - `created` string
  - `updated` string
  - `live` boolean
  - `external_id` string
  - `product_attribute` unknown
  - `cancel_reason_code` unknown
  - `customer_rep` unknown
  - `club` unknown
  - `queued_actions` object[]
  - `prepaid_subscription_context` object
    - `prepaid_orders_remaining` integer
    - `prepaid_orders_per_billing` integer
    - `renewal_behavior` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/ordergroove/apis/ordergroove-restrpc.md) · [All operations](https://skmtc.net/ordergroove/apis/ordergroove-restrpc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ordergroove/ordergroove-restrpc/revisions/ba97e740d08c/schema)