Skip to main content
PATCH
/
v1
/
checkout_portal_protocol
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/checkout_portal_protocol \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "checkout_portal_protocol": {
    "back_url": "https://example.com"
  }
}
'
{
  "id": "cd148977-53d0-4acb-8b25-6827396554e6",
  "object": "checkout_portal_protocol",
  "back_url": "https://example.com",
  "external_enabled": true,
  "external_url": null,
  "manual_checkout_finalize_enabled": true,
  "thank_you_heading": "Thank you for your order!",
  "thank_you_description": "An order confirmation email with details of this order and a link back to this page have been sent to your email address below.",
  "wordpress_plugin_enabled": true,
  "created_at": 1767909679,
  "updated_at": 1767909679
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
checkout_portal_protocol
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
back_url
string | null

The back URL that is shown to customers on the checkout portal. This can be overridden by a back_url on a Checkout.

​
external_enabled
boolean

Whether or not an external checkout portal is being used.

​
external_url
string | null

If external_enabled=true, where is the external portal hosted? If empty, the store's URL is used.

​
manual_checkout_finalize_enabled
boolean

Whether or not finalizing a checkout with manual_payment=true is allowed.

​
thank_you_heading
string | null

The heading that is shown to customers on the order thank you page.

​
thank_you_description
string | null

The description that is shown to customers on the order thank you page.

​
wordpress_plugin_enabled
boolean

Whether or not the WordPress plugin is hosting the checkout portal.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.