v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

Upgrade Subscription To Prepaid

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

patch/subscriptions/{subscription_id}/upgrade_to_prepaid/

Path parameters

subscription_idstring required

Unique subscription ID

Request body

orders_per_billinginteger required

An integer greater than 2

renewal_behavior'autorenew' | 'cancel' | 'downgrade'

offerstring

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

customerstring

merchantstring

productstring

paymentstring

shipping_addressstring

offerstring

subscription_typestring

raw_subscription_typestring

componentsobject[]

public_idstring

quantityinteger

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:price","oasType":"schema","type":"unknown"}

frequency_daysinteger

reminder_daysinteger

everyinteger

every_periodinteger

start_datestring

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:cancelled","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:cancel_reason","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:iteration","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:sequence","oasType":"schema","type":"unknown"}

session_idstring

merchant_order_idstring

createdstring

updatedstring

liveboolean

external_idstring

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:product_attribute","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:cancel_reason_code","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:customer_rep","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/upgrade_to_prepaid/:patch:responses:200:content:application/json:schema:properties:club","oasType":"schema","type":"unknown"}

queued_actionsobject[]

Example response

{
  "customer": "{customer_id}",
  "merchant": "{merchant_id",
  "product": "{product_id}",
  "payment": "{payment_id}",
  "shipping_address": "{shipping_address_id}",
  "offer": "{offer_id}",
  "subscription_type": "replenishment",
  "raw_subscription_type": "replenishment",
  "extra_data": {
    "shopify_contract_id": "gid://shopify/SubscriptionContract/{shopify_contract_id}"
  },
  "public_id": "{public_id}",
  "quantity": 1,
  "frequency_days": 30,
  "reminder_days": 4,
  "every": 1,
  "every_period": 3,
  "start_date": "2023-05-30",
  "session_id": "{session_id}",
  "merchant_order_id": "#1144",
  "created": "2023-05-30 13:20:41",
  "updated": "2023-10-03 10:22:11",
  "live": true,
  "external_id": "{external_id",
  "prepaid_subscription_context": {
    "prepaid_orders_remaining": 4,
    "prepaid_orders_per_billing": 6,
    "renewal_behavior": "autorenew"
  }
}