Skip to main content
GET
/
v1
/
customer_portal_protocol
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/customer_portal_protocol \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{defaultHost}/v1/customer_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/customer_portal_protocol",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/customer_portal_protocol")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "f4a3bb0c-2a1d-453f-9240-8389ba79ae1a",
  "object": "customer_portal_protocol",
  "back_url": null,
  "external_enabled": true,
  "external_url": null,
  "login_enabled": true,
  "privacy_url": null,
  "subscription_cancellations_enabled": true,
  "subscription_updates_enabled": true,
  "subscription_quantity_updates_enabled": true,
  "terms_url": null,
  "wordpress_plugin_enabled": true,
  "created_at": 1782485818,
  "updated_at": 1782485818
}

Authorizations

​
Authorization
string
header
required

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

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 customer portal. This can be overridden by a back_url on a CustomerPortalSession.

​
external_enabled
boolean

Whether or not an external customer 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.

​
login_enabled
boolean

Whether or not customer's can login with their email and a verification code on the hosted customer portal. If disabled, the only way to authenticate a customer is with a CustomerPortalSession.

​
privacy_url
string | null

The privacy policy link that is shown to customers on the customer portal.

​
subscription_cancellations_enabled
boolean

Whether or not customers can cancel subscriptions from the customer portal.

​
subscription_updates_enabled
boolean

Whether or not customers can make subscription changes from the customer portal.

​
subscription_quantity_updates_enabled
boolean

Whether or not customers can change subscription quantities from the customer portal.

​
terms_url
string | null

The terms of service link that is shown to customers on the customer portal.

​
wordpress_plugin_enabled
boolean

Whether or not the WordPress plugin is hosting the customer 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.