Cancel a Subscribe & Save subscription
Cancel the subscription in one step. The cancellation takes effect today unless the offer requires
a minimum number of deliveries that have not yet been made, in which case it takes effect on the date of
the last committed delivery and cancel_effective_on says when. Send preview: true to read that date,
and how many deliveries remain, without cancelling, so the shopper is told before they confirm.
Customer-self access. Works with a publishable key (safe from the
browser). Provide the shopper’s session token in the x-auth-token
header (or the store’s bring-your-own-auth assertion in x-external-auth);
it must resolve to the customer in the {id} path parameter, otherwise the
request returns 403. A subscription that belongs to another shopper reads
as 404.
curl --request POST \
--url https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <x-auth-token>' \
--data '
{
"reason": "Too much coffee",
"preview": false
}
'import requests
url = "https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel"
payload = {
"reason": "Too much coffee",
"preview": False
}
headers = {
"x-auth-token": "<x-auth-token>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-token': '<x-auth-token>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: 'Too much coffee', preview: false})
};
fetch('https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel', 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://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel",
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([
'reason' => 'Too much coffee',
'preview' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-auth-token: <x-auth-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"Too much coffee\",\n \"preview\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-auth-token", "<x-auth-token>")
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.post("https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel")
.header("x-auth-token", "<x-auth-token>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Too much coffee\",\n \"preview\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '<x-auth-token>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Too much coffee\",\n \"preview\": false\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Headers
The signed-in shopper's session token, obtained when the shopper logs in. Must resolve to the customer in the {id} path parameter.
Bring-your-own-auth assertion for stores that manage authentication in an external identity provider (Auth0, Clerk, Cognito, Firebase, NextAuth, SSO). Resolves the shopper whose subscriptions are managed.
Format: <base64url(JSON)>.<base64url(HMAC-SHA256(JSON))> where the JSON is { "external_id": "...", "iat": <unix>, "exp": <unix> } and the HMAC is keyed on the store's hmac_secret. Claim lifetime capped at 300 seconds. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.
A raw token from the store's own identity provider (e.g. a Firebase ID token). Galactic Core forwards it to the store's configured Auth verifier, which validates it against the provider and returns the identity; resolves the shopper whose subscriptions are managed.
Use this when the store wants Galactic Core to verify tokens on its behalf rather than signing an assertion itself. Verification is fail-closed: if the verifier rejects the token or is unreachable, the request is unauthenticated (401). Requires an Auth verifier to be configured for the store. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.
Path Parameters
The shopper's customer id.
The id of the Subscribe & Save subscription.
Body
Response
The subscription after the cancellation, or the cancellation preview when preview is true. A subscription whose offer requires a minimum number of deliveries stays active until cancel_effective_on, and no later delivery is created after it.
- Option 1
- Option 2
A shopper's Subscribe & Save subscription: a recurring delivery they agreed to, with the terms accepted at sign-up. Each delivery after the first is an ordinary order for the store.
status is active, paused, past_due (a delivery could not be paid and is being retried),
cancelled or ended. renewal_mode is off_session when a saved card is charged for each delivery,
or confirm when the shopper pays each delivery from a link sent to them.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <x-auth-token>' \
--data '
{
"reason": "Too much coffee",
"preview": false
}
'import requests
url = "https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel"
payload = {
"reason": "Too much coffee",
"preview": False
}
headers = {
"x-auth-token": "<x-auth-token>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-token': '<x-auth-token>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: 'Too much coffee', preview: false})
};
fetch('https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel', 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://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel",
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([
'reason' => 'Too much coffee',
'preview' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-auth-token: <x-auth-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"Too much coffee\",\n \"preview\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-auth-token", "<x-auth-token>")
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.post("https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel")
.header("x-auth-token", "<x-auth-token>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Too much coffee\",\n \"preview\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '<x-auth-token>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Too much coffee\",\n \"preview\": false\n}"
response = http.request(request)
puts response.read_body