REST RPC APISubscriptions

Update Prepaid Subscription

View as Markdown
This endpoint will allow you to modify the number of orders remaining, the number of orders per billing, and the renewal behavior for a prepaid subscription at any time during the lifecycle of the 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_billingintegerOptional
A number greater than 1
orders_remainingintegerOptional
A number greater than or equal to 0
renewal_behaviorenumOptionalDefaults to autorenew
Allowed values:

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