Skip to main content
PUT
Update multiple line item attributes for a subscription contract

Headers

X-API-Key
string
required

API Key for authentication

Query Parameters

contractId
integer<int64>
required

The unique identifier of the subscription contract

api_key
string

Deprecated: API key (use X-API-Key header instead)

Body

application/json

A JSON object. Each key is a line's id from the contract's lines.nodes, as gid://shopify/SubscriptionLine/<uuid>. Each value is that line's complete list of attributes as key and value pairs, and it replaces all of the line's attributes: include every attribute the line should keep, because any you leave out are removed. Send an empty list to remove them all. The attributes of lines you don't list aren't changed.

{key}
object[]

Response

The contract after the change, with each line's attributes in lines.nodes[].customAttributes. The example is shortened: the response also has the contract's other fields, such as billingPolicy, deliveryPolicy, discounts and the contract's own customAttributes (which this call doesn't change), and more fields on each line and on the customer.

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