REST RPC APISubscriptions

Upgrade Subscription To Prepaid

View as Markdown

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

Authentication

x-api-keystring
API Key authentication via header

Path parameters

subscription_idstringRequired
Unique subscription ID

Request

This endpoint expects an object.
orders_per_billingintegerRequired
An integer greater than 2
renewal_behaviorenumOptionalDefaults to autorenew
Allowed values:
offerstringOptionalDefaults to live

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
componentslist of objects
extra_dataobject
public_idstring
quantityintegerDefaults to 0
priceany
frequency_daysintegerDefaults to 0
reminder_daysintegerDefaults to 0
everyintegerDefaults to 0
every_periodintegerDefaults to 0
start_datestring
cancelledany
cancel_reasonany
iterationany
sequenceany
session_idstring
merchant_order_idstring
createdstring
updatedstring
livebooleanDefaults to true
external_idstring
product_attributeany
cancel_reason_codeany
customer_repany
clubany
queued_actionslist of objects
prepaid_subscription_contextobject

Errors

400
Bad Request Error