Update a product
curl --request PATCH \
--url https://api.beta.suby.fi/v3/products/{id} \
--header 'Content-Type: application/json' \
--header 'X-Suby-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"priceCents": "<string>",
"quantity": 1,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": []
}
'import requests
url = "https://api.beta.suby.fi/v3/products/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"priceCents": "<string>",
"quantity": 1,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": True,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": []
}
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({
name: '<string>',
description: '<string>',
imageUrl: '<string>',
priceCents: '<string>',
quantity: 1,
customFields: [
{
key: '<string>',
label: '<string>',
required: true,
placeholder: '<string>',
options: [{value: '<string>', label: '<string>'}],
validation: {regex: '<string>', errorMessage: '<string>'},
defaultValue: '<string>'
}
],
paymentMethods: []
})
};
fetch('https://api.beta.suby.fi/v3/products/{id}', 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/products/{id}",
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([
'name' => '<string>',
'description' => '<string>',
'imageUrl' => '<string>',
'priceCents' => '<string>',
'quantity' => 1,
'customFields' => [
[
'key' => '<string>',
'label' => '<string>',
'required' => true,
'placeholder' => '<string>',
'options' => [
[
'value' => '<string>',
'label' => '<string>'
]
],
'validation' => [
'regex' => '<string>',
'errorMessage' => '<string>'
],
'defaultValue' => '<string>'
]
],
'paymentMethods' => [
]
]),
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/products/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"priceCents\": \"<string>\",\n \"quantity\": 1,\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"validation\": {\n \"regex\": \"<string>\",\n \"errorMessage\": \"<string>\"\n },\n \"defaultValue\": \"<string>\"\n }\n ],\n \"paymentMethods\": []\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/products/{id}")
.header("X-Suby-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"priceCents\": \"<string>\",\n \"quantity\": 1,\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"validation\": {\n \"regex\": \"<string>\",\n \"errorMessage\": \"<string>\"\n },\n \"defaultValue\": \"<string>\"\n }\n ],\n \"paymentMethods\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beta.suby.fi/v3/products/{id}")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"priceCents\": \"<string>\",\n \"quantity\": 1,\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"validation\": {\n \"regex\": \"<string>\",\n \"errorMessage\": \"<string>\"\n },\n \"defaultValue\": \"<string>\"\n }\n ],\n \"paymentMethods\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pro_abc123",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"priceCents": "<string>",
"recurringIntervalCount": 123,
"recurringCycleCount": 123,
"trialDurationCount": 123,
"trialRequiresPaymentMethod": true,
"quantity": 123,
"consumedQuantity": 123,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [],
"createdAt": "2023-11-07T05:31:56Z",
"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"
}{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Validation failed",
"data": {
"fieldErrors": [
{
"field": "method",
"message": "method is a required field"
}
]
}
}Products
Update a product
Partial update. Recurring/trial fields cannot be changed here.
PATCH
/
v3
/
products
/
{id}
Update a product
curl --request PATCH \
--url https://api.beta.suby.fi/v3/products/{id} \
--header 'Content-Type: application/json' \
--header 'X-Suby-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"priceCents": "<string>",
"quantity": 1,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": []
}
'import requests
url = "https://api.beta.suby.fi/v3/products/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"priceCents": "<string>",
"quantity": 1,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": True,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": []
}
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({
name: '<string>',
description: '<string>',
imageUrl: '<string>',
priceCents: '<string>',
quantity: 1,
customFields: [
{
key: '<string>',
label: '<string>',
required: true,
placeholder: '<string>',
options: [{value: '<string>', label: '<string>'}],
validation: {regex: '<string>', errorMessage: '<string>'},
defaultValue: '<string>'
}
],
paymentMethods: []
})
};
fetch('https://api.beta.suby.fi/v3/products/{id}', 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/products/{id}",
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([
'name' => '<string>',
'description' => '<string>',
'imageUrl' => '<string>',
'priceCents' => '<string>',
'quantity' => 1,
'customFields' => [
[
'key' => '<string>',
'label' => '<string>',
'required' => true,
'placeholder' => '<string>',
'options' => [
[
'value' => '<string>',
'label' => '<string>'
]
],
'validation' => [
'regex' => '<string>',
'errorMessage' => '<string>'
],
'defaultValue' => '<string>'
]
],
'paymentMethods' => [
]
]),
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/products/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"priceCents\": \"<string>\",\n \"quantity\": 1,\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"validation\": {\n \"regex\": \"<string>\",\n \"errorMessage\": \"<string>\"\n },\n \"defaultValue\": \"<string>\"\n }\n ],\n \"paymentMethods\": []\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/products/{id}")
.header("X-Suby-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"priceCents\": \"<string>\",\n \"quantity\": 1,\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"validation\": {\n \"regex\": \"<string>\",\n \"errorMessage\": \"<string>\"\n },\n \"defaultValue\": \"<string>\"\n }\n ],\n \"paymentMethods\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beta.suby.fi/v3/products/{id}")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"priceCents\": \"<string>\",\n \"quantity\": 1,\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"validation\": {\n \"regex\": \"<string>\",\n \"errorMessage\": \"<string>\"\n },\n \"defaultValue\": \"<string>\"\n }\n ],\n \"paymentMethods\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pro_abc123",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"priceCents": "<string>",
"recurringIntervalCount": 123,
"recurringCycleCount": 123,
"trialDurationCount": 123,
"trialRequiresPaymentMethod": true,
"quantity": 123,
"consumedQuantity": 123,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [],
"createdAt": "2023-11-07T05:31:56Z",
"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"
}{
"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).
Path Parameters
Example:
"pro_abc123"
Body
application/json
Maximum string length:
200Maximum string length:
2000Available options:
DRAFT, ACTIVE, ARCHIVED Available options:
WEBHOOK_ONLY, PLATFORM_ACCESS Pattern:
^\d+$Available options:
EUR, USD Required range:
x >= 0Extra fields collected on the hosted checkout page (max 10).
Maximum array length:
10Show child attributes
Show child attributes
Per-product payment-method whitelist. null / [] / omitted = the product accepts every method enabled on the account. A non-empty list restricts checkout to these categories (always intersected with the account's enabled methods, so listing a disabled method is a harmless no-op).
Available options:
CARD, APPLE_PAY, GOOGLE_PAY, KLARNA, IDEAL, BANCONTACT, TWINT, BLIK, AFFIRM, MULTIBANCO, PAYPAL, SEPA_DIRECT_DEBIT, ACH_DIRECT_DEBIT, STABLECOIN, VOLATILE_CRYPTO Was this page helpful?
⌘I

