Update an order subscription item
How to update an existing order subscription item via API
To update an existing order subscription item, send a PATCH request to the /api/order_subscription_items/:id endpoint, where id is the ID of the resource that you want to update.
Here below the list of all the possible arguments that you can pass with the request body.
Request
PATCH https://yourdomain.commercelayer.io/api/order_subscription_items/:id
Arguments
type
string
Required
id
string
Required
attributes.sku_code
string
Optional
attributes.bundle_code
string
Optional
attributes.quantity
integer
Optional
attributes.unit_amount_cents
integer
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
Example
The following request updates the order subscription item identified by the ID "XAyRWNUzyN":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "order_subscription_items",
"id": "xYZkjABcde",
"attributes": {
"sku_code": "TSHIRTMM000000FFFFFFXLXX"
}
}
}'On success, the API responds with a 200 OK status code, returning the updated resource object:
{
"data": {
"id": "XAyRWNUzyN",
"type": "order_subscription_items",
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN"
},
"attributes": {
"sku_code": "TSHIRTMM000000FFFFFFXLXX",
"bundle_code": "BUNDLEMM000000FFFFFFXLXX",
"quantity": 4,
"unit_amount_cents": 9900,
"unit_amount_float": 99.0,
"formatted_unit_amount": "€99,00",
"total_amount_cents": 18800,
"total_amount_float": 188.0,
"formatted_total_amount": "€188,00",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"order_subscription": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/order_subscription",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/order_subscription"
}
},
"item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/item",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/item"
}
},
"sku": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/sku",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/sku"
}
},
"bundle": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/bundle",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/bundle"
}
},
"adjustment": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/adjustment",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/adjustment"
}
},
"source_line_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/source_line_item",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/source_line_item"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated

