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"
  }
}
'
import requests

url = "https://{defaultHost}/v1/checkout_portal_protocol"

payload = { "checkout_portal_protocol": { "back_url": "https://example.com" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({checkout_portal_protocol: {back_url: 'https://example.com'}})
};

fetch('https://{defaultHost}/v1/checkout_portal_protocol', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/v1/checkout_portal_protocol",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'checkout_portal_protocol' => [
'back_url' => 'https://example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{defaultHost}/v1/checkout_portal_protocol"

payload := strings.NewReader("{\n \"checkout_portal_protocol\": {\n \"back_url\": \"https://example.com\"\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://{defaultHost}/v1/checkout_portal_protocol")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"checkout_portal_protocol\": {\n \"back_url\": \"https://example.com\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/v1/checkout_portal_protocol")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"checkout_portal_protocol\": {\n \"back_url\": \"https://example.com\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "7c52c557-30d5-4220-a6d9-7bd842d4967c",
  "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": 1782485812,
  "updated_at": 1782485812
}

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.