Update notification preferences
curl --request PATCH \
--url https://api.beta.suby.fi/v3/notification-preferences \
--header 'Content-Type: application/json' \
--header 'X-Suby-Api-Key: <api-key>' \
--data '
{
"preferences": {
"teamAlerts": {
"newPayment": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"payoutReceived": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"chargeback": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeDeadline": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeOutcome": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"subscriptionCanceled": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
}
},
"customerEmails": {
"receipt": {
"enabled": true
}
}
}
}
'import requests
url = "https://api.beta.suby.fi/v3/notification-preferences"
payload = { "preferences": {
"teamAlerts": {
"newPayment": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"payoutReceived": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"chargeback": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"disputeDeadline": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"disputeOutcome": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"subscriptionCanceled": {
"enabled": True,
"recipients": ["jsmith@example.com"]
}
},
"customerEmails": { "receipt": { "enabled": True } }
} }
headers = {
"X-Suby-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Suby-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
preferences: {
teamAlerts: {
newPayment: {enabled: true, recipients: ['jsmith@example.com']},
payoutReceived: {enabled: true, recipients: ['jsmith@example.com']},
chargeback: {enabled: true, recipients: ['jsmith@example.com']},
disputeDeadline: {enabled: true, recipients: ['jsmith@example.com']},
disputeOutcome: {enabled: true, recipients: ['jsmith@example.com']},
subscriptionCanceled: {enabled: true, recipients: ['jsmith@example.com']}
},
customerEmails: {receipt: {enabled: true}}
}
})
};
fetch('https://api.beta.suby.fi/v3/notification-preferences', 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.beta.suby.fi/v3/notification-preferences",
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([
'preferences' => [
'teamAlerts' => [
'newPayment' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'payoutReceived' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'chargeback' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'disputeDeadline' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'disputeOutcome' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'subscriptionCanceled' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
]
],
'customerEmails' => [
'receipt' => [
'enabled' => true
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Suby-Api-Key: <api-key>"
],
]);
$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.beta.suby.fi/v3/notification-preferences"
payload := strings.NewReader("{\n \"preferences\": {\n \"teamAlerts\": {\n \"newPayment\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"payoutReceived\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"chargeback\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeDeadline\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeOutcome\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"subscriptionCanceled\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n }\n },\n \"customerEmails\": {\n \"receipt\": {\n \"enabled\": true\n }\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Suby-Api-Key", "<api-key>")
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://api.beta.suby.fi/v3/notification-preferences")
.header("X-Suby-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"preferences\": {\n \"teamAlerts\": {\n \"newPayment\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"payoutReceived\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"chargeback\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeDeadline\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeOutcome\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"subscriptionCanceled\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n }\n },\n \"customerEmails\": {\n \"receipt\": {\n \"enabled\": true\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beta.suby.fi/v3/notification-preferences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Suby-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"preferences\": {\n \"teamAlerts\": {\n \"newPayment\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"payoutReceived\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"chargeback\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeDeadline\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeOutcome\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"subscriptionCanceled\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n }\n },\n \"customerEmails\": {\n \"receipt\": {\n \"enabled\": true\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "<string>",
"preferences": {
"teamAlerts": {
"newPayment": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"payoutReceived": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"chargeback": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeDeadline": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeOutcome": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"subscriptionCanceled": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
}
},
"customerEmails": {
"receipt": {
"enabled": true
}
}
},
"merchantOfRecord": true,
"updatedAt": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"success": false,
"error": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}{
"success": false,
"error": "NOT_FOUND",
"message": "Resource not found",
"data": "<unknown>"
}{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Validation failed",
"data": {
"fieldErrors": [
{
"field": "method",
"message": "method is a required field"
}
]
}
}Notifications
Update notification preferences
Send the whole preferences object — it replaces the stored value. Pass
null to reset to the product defaults.
Merchant-of-Record organizations cannot disable customerEmails.receipt:
Suby is the legal seller and issues the receipt. Sending
{"enabled": false} returns 403 CUSTOMER_EMAIL_LOCKED_MOR. Check
merchantOfRecord on the response to know whether the lock applies.
PATCH
/
v3
/
notification-preferences
Update notification preferences
curl --request PATCH \
--url https://api.beta.suby.fi/v3/notification-preferences \
--header 'Content-Type: application/json' \
--header 'X-Suby-Api-Key: <api-key>' \
--data '
{
"preferences": {
"teamAlerts": {
"newPayment": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"payoutReceived": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"chargeback": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeDeadline": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeOutcome": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"subscriptionCanceled": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
}
},
"customerEmails": {
"receipt": {
"enabled": true
}
}
}
}
'import requests
url = "https://api.beta.suby.fi/v3/notification-preferences"
payload = { "preferences": {
"teamAlerts": {
"newPayment": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"payoutReceived": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"chargeback": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"disputeDeadline": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"disputeOutcome": {
"enabled": True,
"recipients": ["jsmith@example.com"]
},
"subscriptionCanceled": {
"enabled": True,
"recipients": ["jsmith@example.com"]
}
},
"customerEmails": { "receipt": { "enabled": True } }
} }
headers = {
"X-Suby-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Suby-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
preferences: {
teamAlerts: {
newPayment: {enabled: true, recipients: ['jsmith@example.com']},
payoutReceived: {enabled: true, recipients: ['jsmith@example.com']},
chargeback: {enabled: true, recipients: ['jsmith@example.com']},
disputeDeadline: {enabled: true, recipients: ['jsmith@example.com']},
disputeOutcome: {enabled: true, recipients: ['jsmith@example.com']},
subscriptionCanceled: {enabled: true, recipients: ['jsmith@example.com']}
},
customerEmails: {receipt: {enabled: true}}
}
})
};
fetch('https://api.beta.suby.fi/v3/notification-preferences', 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.beta.suby.fi/v3/notification-preferences",
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([
'preferences' => [
'teamAlerts' => [
'newPayment' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'payoutReceived' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'chargeback' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'disputeDeadline' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'disputeOutcome' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
],
'subscriptionCanceled' => [
'enabled' => true,
'recipients' => [
'jsmith@example.com'
]
]
],
'customerEmails' => [
'receipt' => [
'enabled' => true
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Suby-Api-Key: <api-key>"
],
]);
$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.beta.suby.fi/v3/notification-preferences"
payload := strings.NewReader("{\n \"preferences\": {\n \"teamAlerts\": {\n \"newPayment\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"payoutReceived\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"chargeback\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeDeadline\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeOutcome\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"subscriptionCanceled\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n }\n },\n \"customerEmails\": {\n \"receipt\": {\n \"enabled\": true\n }\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Suby-Api-Key", "<api-key>")
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://api.beta.suby.fi/v3/notification-preferences")
.header("X-Suby-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"preferences\": {\n \"teamAlerts\": {\n \"newPayment\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"payoutReceived\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"chargeback\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeDeadline\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeOutcome\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"subscriptionCanceled\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n }\n },\n \"customerEmails\": {\n \"receipt\": {\n \"enabled\": true\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beta.suby.fi/v3/notification-preferences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Suby-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"preferences\": {\n \"teamAlerts\": {\n \"newPayment\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"payoutReceived\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"chargeback\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeDeadline\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"disputeOutcome\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n },\n \"subscriptionCanceled\": {\n \"enabled\": true,\n \"recipients\": [\n \"jsmith@example.com\"\n ]\n }\n },\n \"customerEmails\": {\n \"receipt\": {\n \"enabled\": true\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "<string>",
"preferences": {
"teamAlerts": {
"newPayment": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"payoutReceived": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"chargeback": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeDeadline": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"disputeOutcome": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
},
"subscriptionCanceled": {
"enabled": true,
"recipients": [
"jsmith@example.com"
]
}
},
"customerEmails": {
"receipt": {
"enabled": true
}
}
},
"merchantOfRecord": true,
"updatedAt": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"success": false,
"error": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}{
"success": false,
"error": "NOT_FOUND",
"message": "Resource not found",
"data": "<unknown>"
}{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Validation failed",
"data": {
"fieldErrors": [
{
"field": "method",
"message": "method is a required field"
}
]
}
}Authorizations
Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).
Body
application/json
null resets to the product defaults.
Show child attributes
Show child attributes
Was this page helpful?
⌘I

