Checkouts
Retrieve a checkout's items
- Documentation
- API Reference
- Community
- The Customer object
- POSTCreate a customer
- POSTUpdate a customer
- GETRetrieve a customer
- GETList all customers
- DELDelete a customer
- The Product object
- POSTCreate a product
- POSTUpdate a Product
- GETRetrieve a product
- GETList all products
- DELDelete a product
- GETRetrieve a products's prices
Customers
Products
Checkouts
Retrieve a checkout's items
Retrieves all the items of a checkout.
GET
/
checkouts
/
{id}
/
items
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
id
string
id
string
The ID of the checkout.
per_page
integer
per_page
integer
A numeric value indicating the quantity of checkouts to be returned with the request, with a minimum value of 1 and a maximum value of 50.
curl --request GET \
--url https://pay.chargily.net/test/api/v2/checkouts/{id}/items \
--header 'Authorization: Bearer <token>'
{
"livemode": false,
"current_page": 1,
"data": [
{
"id": "01hhhtkgqfqq3azf2dag3qv0eh",
"entity": "price",
"amount": 2500,
"quantity": 1,
"currency": "dzd",
"metadata": null,
"created_at": 1702479119,
"updated_at": 1702479119,
"product_id": "01hhhtkg70gca88n1h65wpe8gn"
},
{
"id": "01hhhtkgqsxmdsse82vnmeg26n",
"entity": "price",
"amount": 5000,
"quantity": 10,
"currency": "dzd",
"metadata": null,
"created_at": 1702479119,
"updated_at": 1702479119,
"product_id": "01hhhtkg70gca88n1h65wpe8gn"
}
],
"first_page_url": "https://pay.chargily.net/test/api/v2/checkouts/01hhhv1s23gpcsx40az6z9sy71/items?page=1",
"last_page": 1,
"last_page_url": "https://pay.chargily.net/test/api/v2/checkouts/01hhhv1s23gpcsx40az6z9sy71/items?page=1",
"next_page_url": null,
"path": "https://pay.chargily.net/test/api/v2/checkouts/01hhhv1s23gpcsx40az6z9sy71/items",
"per_page": 10,
"prev_page_url": null,
"total": 2
}
Path parameters
id
string
The ID of the checkout.
Query parameters
per_page
integer
A numeric value indicating the quantity of checkouts to be returned with the request, with a minimum value of 1 and a maximum value of 50.
Returns
A key-value array, containing a data property which is an array of all the items of the checkout, limited to a maximum of per_page
value.
curl --request GET \
--url https://pay.chargily.net/test/api/v2/checkouts/{id}/items \
--header 'Authorization: Bearer <token>'
{
"livemode": false,
"current_page": 1,
"data": [
{
"id": "01hhhtkgqfqq3azf2dag3qv0eh",
"entity": "price",
"amount": 2500,
"quantity": 1,
"currency": "dzd",
"metadata": null,
"created_at": 1702479119,
"updated_at": 1702479119,
"product_id": "01hhhtkg70gca88n1h65wpe8gn"
},
{
"id": "01hhhtkgqsxmdsse82vnmeg26n",
"entity": "price",
"amount": 5000,
"quantity": 10,
"currency": "dzd",
"metadata": null,
"created_at": 1702479119,
"updated_at": 1702479119,
"product_id": "01hhhtkg70gca88n1h65wpe8gn"
}
],
"first_page_url": "https://pay.chargily.net/test/api/v2/checkouts/01hhhv1s23gpcsx40az6z9sy71/items?page=1",
"last_page": 1,
"last_page_url": "https://pay.chargily.net/test/api/v2/checkouts/01hhhv1s23gpcsx40az6z9sy71/items?page=1",
"next_page_url": null,
"path": "https://pay.chargily.net/test/api/v2/checkouts/01hhhv1s23gpcsx40az6z9sy71/items",
"per_page": 10,
"prev_page_url": null,
"total": 2
}