Skip to main content
PUT
Add a fixed pricing bundle line item, with its child products, to a subscription contract

Query Parameters

contractId
integer<int64>
required

The subscriptionContractId of the customer's subscription.

quantity
integer<int32>
default:1

How many boxes to add, each with the contents in the request body. It must be at least the store's minimum quantity for adding products.

variantId
string
required

The variant of the box's parent product, as a numeric ID or a gid://shopify/ProductVariant/... GID. It must be a variant of a parent product that the subscription's box is set up for.

Body

application/json

What goes in one box: each key is a child product's numeric variant ID, as a JSON string (not a GID), and each value is how many of it go in the box.

{key}
integer<int32>

Response

200 - */*

OK

billingAttempts
object
billingPolicy
object
createdAt
object
customAttributes
object[]
customer
object
customerPaymentMethod
object
deliveryMethod
object
deliveryPolicy
object
deliveryPrice
object
discounts
object
get__typename
string
id
string
lastPaymentStatus
enum<string>
Available options:
SUCCEEDED,
FAILED,
$UNKNOWN
lines
object
nextBillingDate
object
note
string
originOrder
object
revisionId
object
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED,
FAILED,
$UNKNOWN
updatedAt
object