Skip to main content
POST
/
subscriptions
/
cp
/
api
/
customer-account-api
/
initiate
Initiate Customer Account API OAuth flow
curl --request POST \
  --url https://www.myshop.com/apps/subscriptions/cp/api/customer-account-api/initiate \
  --header 'Content-Type: application/json' \
  --data '
{
  "returnUrl": "https://myshop.com/account/subscriptions"
}
'
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/customer-account-api/initiate"

payload = { "returnUrl": "https://myshop.com/account/subscriptions" }
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({returnUrl: 'https://myshop.com/account/subscriptions'})
};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/customer-account-api/initiate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/customer-account-api/initiate';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({returnUrl: 'https://myshop.com/account/subscriptions'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/customer-account-api/initiate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returnUrl' => 'https://myshop.com/account/subscriptions'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://www.myshop.com/apps/subscriptions/cp/api/customer-account-api/initiate"

	payload := strings.NewReader("{\n  \"returnUrl\": \"https://myshop.com/account/subscriptions\"\n}")

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

	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))

}
require 'uri'
require 'net/http'

url = URI("https://www.myshop.com/apps/subscriptions/cp/api/customer-account-api/initiate")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returnUrl\": \"https://myshop.com/account/subscriptions\"\n}"

response = http.request(request)
puts response.read_body
{
  "authorizationUrl": "https://shopify.com/12345/auth/oauth/authorize?client_id=...",
  "state": "random-state-value-for-csrf-protection"
}
{}
{
  "error": "oidc_discovery_failed",
  "message": "Customer Account API is not available for this shop. Please ensure New Customer Accounts is enabled."
}

Body

application/json

OAuth initiation request with return URL

returnUrl
string

Response

OAuth flow initiated successfully