Skip to main content
POST
Update package

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <live_api_key>.

Body

multipart/form-data
id
integer
required
group_id
integer
required
name
string
required
description
string
tax
number
url
string
prorate
enum<string>
Available options:
Y,
N
trial
string
options
string[]
keep
string[]
files
file
product_images
file
cycle.cycle
string[]
cycle.price
string[]
cycle.setup
string[]
Available options:
0,
1
upgrade_paths
string[]
cycle.id
string[]

Required to change cycles: pass an existing cycle id to update that cycle, or null to add a new one. Existing cycles whose id is not listed are deleted. Omit all cycle fields to leave cycles unchanged.

upgrade_paths.*.target_package_id
integer

Target package id for upgrade path

upgrade_paths.*.sort_order
string[]

Optional upgrade path sort order

theme
enum<integer>

Order page theme: 1 = ecommerce view, 2 = simple. Defaults to 2 on create.

Available options:
1,
2
qty
integer

Stock quantity

Required range: x >= 0
is_outofstock
enum<string>

Whether the package is marked out of stock

Available options:
0,
1
digital_delivery
object

For multipart clients, send nested fields using bracket notation such as digital_delivery[delivery_enabled].

Response

OK

success
boolean