Comment on page
Create an order subscription item
How to create an order subscription item via API
To create a new order subscription item, send a
POST
request to the /api/order_subscription_items
endpoint, passing the resource arguments in the request body.POST https://yourdomain.commercelayer.io/api/order_subscription_items
Body Parameter | Type | Required |
---|---|---|
type | string | Required |
attributes.sku_code | string | Optional |
attributes.bundle_code | string | Optional |
attributes.quantity | integer | Required |
attributes.unit_amount_cents | integer | Optional, inherited by item |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
relationships.order_subscription | object | Required |
relationships.item | object | Required |
relationships.sku | object | Optional |
relationships.bundle | object | Optional |
Request
Response
The following request creates a new order subscription item:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/order_subscription_items' \
-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",
"attributes": {
"quantity": 4
},
"relationships": {
"order_subscription": {
"data": {
"type": "order_subscriptions",
"id": "ABCRtyUpBa"
}
},
"item": {
"data": {
"type": "items",
"id": "BCDRtyUpBa"
}
}
}
}
}'
On success, the API responds with a
201 Created
status code, returning the created resource object:{
"data": {
"id": "xYZkjABcde",
"type": "order_subscription_items",
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde"
},
"attributes": {
"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/xYZkjABcde/relationships/order_subscription",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/order_subscription"
}
},
"item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/relationships/item",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/item"
}
},
"sku": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/relationships/sku",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/sku"
}
},
"bundle": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/relationships/bundle",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/bundle"
}
},
"source_line_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/relationships/source_line_item",
"related": "https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde/source_line_item"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago