Comment on page
Retrieve an order subscription item
How to fetch a specific order subscription item via API
To fetch a single order subscription item, send a
GET request to the /api/order_subscription_items/:id endpoint, where id is the ID of the resource that you want to retrieve.GET https://yourdomain.commercelayer.io/api/order_subscription_items/:id
Request
Response
The following request fetches the order subscription item identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/order_subscription_items/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a
200 OK status code, returning a single 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