Retrieve a Checkout

Retrieves the details of an existing Checkout. Supply a unique Checkout ID from the Checkout list, and PriceBlocs will return the corresponding Checkout information.
Parameters
Has no parameters
Returns
  • Returns a Checkout object if a valid identifier was provided.
Have any questions?
GET
/v1/checkouts/:id
1
curl https://api.priceblocs.com/v1/checkouts/{{CHECKOUT_ID}} \
2
-H "Authorization: Bearer {{API_KEY_SECRET_TEST}}"
Response
1
{
2
"id": "07c432bf-cf5e-4900-a230-4e6de93d2bda",
3
"session_id": "cs_test_a1GuW4bP52ni9Si7PNx28wFi0Swi5sXR0tkKzaunIMIpp2nHAn5JGGaOwM",
4
"status": "started",
5
"line_items": [
6
{
7
"price": "price_123",
8
"product": "prod_123",
9
"currency": "usd",
10
"quantity": 1,
11
"recurring": null
12
}
13
],
14
"form_data": [
15
[
16
{
17
"uid": "input",
18
"label": "User input",
19
"value": "The field value at the time of form submission."
20
}
21
]
22
],
23
"amount_total": 4750,
24
"amount_tax": 250,
25
"amount_discount": 5000,
26
"amount_subtotal": 7500,
27
"mode": "subscription",
28
"customer": null,
29
"email": null,
30
"currency": "usd",
31
"livemode": false,
32
"object": "checkout",
33
"subscription_id": null,
34
"payment_intent_id": "pi_123",
35
"client_reference_id": null,
36
"payment_link_id": "fbbfeb9a-be9b-4658-80ad-cdb47ff86fc3",
37
"payment_link_short_id": "YEZWSa8LjqGN5aPER7-Lw",
38
"page_id": null,
39
"route": null,
40
"ip": "127.0.0.1",
41
"os": "Mac OS X 10.15.7",
42
"origin": "https://priceblocs.com",
43
"browser": "Chrome",
44
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
45
"device": "Other 0.0.0",
46
"device_version": "0.0.0",
47
"fulfillment": null,
48
"payment_type": "one_time",
49
"automatic_tax": false,
50
"tax_id_collection": false,
51
"payment_status": "unpaid",
52
"payment_intent_capture_method": "automatic",
53
"shipping_rates": "shr_123",
54
"tax_rates": "txr_123",
55
"coupons": "Ab8u1Zli",
56
"promotion_codes": null,
57
"trial_period_days": 14,
58
"metadata": null,
59
"adjustable_quantity_enabled": true,
60
"recovery_enabled": false,
61
"recovered_from": null,
62
"created": 1628958666,
63
"updated": 1628958666
64
}
Show docs menu

Retrieve a Checkout

Retrieves the details of an existing Checkout. Supply a unique Checkout ID from the Checkout list, and PriceBlocs will return the corresponding Checkout information.
Parameters
Has no parameters
Returns
  • Returns a Checkout object if a valid identifier was provided.
Have any questions?
GET
/v1/checkouts/:id
1
curl https://api.priceblocs.com/v1/checkouts/{{CHECKOUT_ID}} \
2
-H "Authorization: Bearer {{API_KEY_SECRET_TEST}}"
Response
1
{
2
"id": "07c432bf-cf5e-4900-a230-4e6de93d2bda",
3
"session_id": "cs_test_a1GuW4bP52ni9Si7PNx28wFi0Swi5sXR0tkKzaunIMIpp2nHAn5JGGaOwM",
4
"status": "started",
5
"line_items": [
6
{
7
"price": "price_123",
8
"product": "prod_123",
9
"currency": "usd",
10
"quantity": 1,
11
"recurring": null
12
}
13
],
14
"form_data": [
15
[
16
{
17
"uid": "input",
18
"label": "User input",
19
"value": "The field value at the time of form submission."
20
}
21
]
22
],
23
"amount_total": 4750,
24
"amount_tax": 250,
25
"amount_discount": 5000,
26
"amount_subtotal": 7500,
27
"mode": "subscription",
28
"customer": null,
29
"email": null,
30
"currency": "usd",
31
"livemode": false,
32
"object": "checkout",
33
"subscription_id": null,
34
"payment_intent_id": "pi_123",
35
"client_reference_id": null,
36
"payment_link_id": "fbbfeb9a-be9b-4658-80ad-cdb47ff86fc3",
37
"payment_link_short_id": "YEZWSa8LjqGN5aPER7-Lw",
38
"page_id": null,
39
"route": null,
40
"ip": "127.0.0.1",
41
"os": "Mac OS X 10.15.7",
42
"origin": "https://priceblocs.com",
43
"browser": "Chrome",
44
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
45
"device": "Other 0.0.0",
46
"device_version": "0.0.0",
47
"fulfillment": null,
48
"payment_type": "one_time",
49
"automatic_tax": false,
50
"tax_id_collection": false,
51
"payment_status": "unpaid",
52
"payment_intent_capture_method": "automatic",
53
"shipping_rates": "shr_123",
54
"tax_rates": "txr_123",
55
"coupons": "Ab8u1Zli",
56
"promotion_codes": null,
57
"trial_period_days": 14,
58
"metadata": null,
59
"adjustable_quantity_enabled": true,
60
"recovery_enabled": false,
61
"recovered_from": null,
62
"created": 1628958666,
63
"updated": 1628958666
64
}