Create a product
curl --request POST \
--url https://api.beta.suby.fi/v3/products \
--header 'Content-Type: application/json' \
--header 'X-Suby-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"status": "ACTIVE",
"billingMode": "onetime",
"priceCents": "<string>",
"recurringIntervalCount": 2,
"recurringCycleCount": 2,
"quantity": 1,
"taxBehavior": "exclusive",
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [],
"successUrl": "<string>",
"cancelUrl": "<string>"
}
'import requests
url = "https://api.beta.suby.fi/v3/products"
payload = {
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"status": "ACTIVE",
"billingMode": "onetime",
"priceCents": "<string>",
"recurringIntervalCount": 2,
"recurringCycleCount": 2,
"quantity": 1,
"taxBehavior": "exclusive",
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": True,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [],
"successUrl": "<string>",
"cancelUrl": "<string>"
}
headers = {
"X-Suby-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Suby-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
imageUrl: '<string>',
status: 'ACTIVE',
billingMode: 'onetime',
priceCents: '<string>',
recurringIntervalCount: 2,
recurringCycleCount: 2,
quantity: 1,
taxBehavior: 'exclusive',
customFields: [
{
key: '<string>',
label: '<string>',
required: true,
placeholder: '<string>',
options: [{value: '<string>', label: '<string>'}],
validation: {regex: '<string>', errorMessage: '<string>'},
defaultValue: '<string>'
}
],
paymentMethods: [],
successUrl: '<string>',
cancelUrl: '<string>'
})
};
fetch('https://api.beta.suby.fi/v3/products', 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",
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([
'name' => '<string>',
'description' => '<string>',
'imageUrl' => '<string>',
'status' => 'ACTIVE',
'billingMode' => 'onetime',
'priceCents' => '<string>',
'recurringIntervalCount' => 2,
'recurringCycleCount' => 2,
'quantity' => 1,
'taxBehavior' => 'exclusive',
'customFields' => [
[
'key' => '<string>',
'label' => '<string>',
'required' => true,
'placeholder' => '<string>',
'options' => [
[
'value' => '<string>',
'label' => '<string>'
]
],
'validation' => [
'regex' => '<string>',
'errorMessage' => '<string>'
],
'defaultValue' => '<string>'
]
],
'paymentMethods' => [
],
'successUrl' => '<string>',
'cancelUrl' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"billingMode\": \"onetime\",\n \"priceCents\": \"<string>\",\n \"recurringIntervalCount\": 2,\n \"recurringCycleCount\": 2,\n \"quantity\": 1,\n \"taxBehavior\": \"exclusive\",\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 \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.beta.suby.fi/v3/products")
.header("X-Suby-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"billingMode\": \"onetime\",\n \"priceCents\": \"<string>\",\n \"recurringIntervalCount\": 2,\n \"recurringCycleCount\": 2,\n \"quantity\": 1,\n \"taxBehavior\": \"exclusive\",\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 \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beta.suby.fi/v3/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"status\": \"ACTIVE\",\n \"billingMode\": \"onetime\",\n \"priceCents\": \"<string>\",\n \"recurringIntervalCount\": 2,\n \"recurringCycleCount\": 2,\n \"quantity\": 1,\n \"taxBehavior\": \"exclusive\",\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 \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pro_abc123",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"status": "DRAFT",
"billingMode": "onetime",
"priceCents": "<string>",
"currency": "EUR",
"recurringInterval": "DAY",
"recurringIntervalCount": 123,
"recurringCycleCount": 123,
"quantity": 123,
"consumedQuantity": 123,
"taxInclusive": true,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"type": "input",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [
"CARD"
],
"successUrl": "<string>",
"cancelUrl": "<string>",
"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": "VALIDATION_ERROR",
"message": "Validation failed",
"data": {
"fieldErrors": [
{
"field": "method",
"message": "method is a required field"
}
]
}
}Products
Create a product
POST
/
v3
/
products
Create a product
curl --request POST \
--url https://api.beta.suby.fi/v3/products \
--header 'Content-Type: application/json' \
--header 'X-Suby-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"status": "ACTIVE",
"billingMode": "onetime",
"priceCents": "<string>",
"recurringIntervalCount": 2,
"recurringCycleCount": 2,
"quantity": 1,
"taxBehavior": "exclusive",
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [],
"successUrl": "<string>",
"cancelUrl": "<string>"
}
'import requests
url = "https://api.beta.suby.fi/v3/products"
payload = {
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"status": "ACTIVE",
"billingMode": "onetime",
"priceCents": "<string>",
"recurringIntervalCount": 2,
"recurringCycleCount": 2,
"quantity": 1,
"taxBehavior": "exclusive",
"customFields": [
{
"key": "<string>",
"label": "<string>",
"required": True,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [],
"successUrl": "<string>",
"cancelUrl": "<string>"
}
headers = {
"X-Suby-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Suby-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
imageUrl: '<string>',
status: 'ACTIVE',
billingMode: 'onetime',
priceCents: '<string>',
recurringIntervalCount: 2,
recurringCycleCount: 2,
quantity: 1,
taxBehavior: 'exclusive',
customFields: [
{
key: '<string>',
label: '<string>',
required: true,
placeholder: '<string>',
options: [{value: '<string>', label: '<string>'}],
validation: {regex: '<string>', errorMessage: '<string>'},
defaultValue: '<string>'
}
],
paymentMethods: [],
successUrl: '<string>',
cancelUrl: '<string>'
})
};
fetch('https://api.beta.suby.fi/v3/products', 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",
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([
'name' => '<string>',
'description' => '<string>',
'imageUrl' => '<string>',
'status' => 'ACTIVE',
'billingMode' => 'onetime',
'priceCents' => '<string>',
'recurringIntervalCount' => 2,
'recurringCycleCount' => 2,
'quantity' => 1,
'taxBehavior' => 'exclusive',
'customFields' => [
[
'key' => '<string>',
'label' => '<string>',
'required' => true,
'placeholder' => '<string>',
'options' => [
[
'value' => '<string>',
'label' => '<string>'
]
],
'validation' => [
'regex' => '<string>',
'errorMessage' => '<string>'
],
'defaultValue' => '<string>'
]
],
'paymentMethods' => [
],
'successUrl' => '<string>',
'cancelUrl' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"billingMode\": \"onetime\",\n \"priceCents\": \"<string>\",\n \"recurringIntervalCount\": 2,\n \"recurringCycleCount\": 2,\n \"quantity\": 1,\n \"taxBehavior\": \"exclusive\",\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 \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.beta.suby.fi/v3/products")
.header("X-Suby-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"billingMode\": \"onetime\",\n \"priceCents\": \"<string>\",\n \"recurringIntervalCount\": 2,\n \"recurringCycleCount\": 2,\n \"quantity\": 1,\n \"taxBehavior\": \"exclusive\",\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 \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beta.suby.fi/v3/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"status\": \"ACTIVE\",\n \"billingMode\": \"onetime\",\n \"priceCents\": \"<string>\",\n \"recurringIntervalCount\": 2,\n \"recurringCycleCount\": 2,\n \"quantity\": 1,\n \"taxBehavior\": \"exclusive\",\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 \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pro_abc123",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"status": "DRAFT",
"billingMode": "onetime",
"priceCents": "<string>",
"currency": "EUR",
"recurringInterval": "DAY",
"recurringIntervalCount": 123,
"recurringCycleCount": 123,
"quantity": 123,
"consumedQuantity": 123,
"taxInclusive": true,
"customFields": [
{
"key": "<string>",
"label": "<string>",
"type": "input",
"required": true,
"placeholder": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"validation": {
"regex": "<string>",
"errorMessage": "<string>"
},
"defaultValue": "<string>"
}
],
"paymentMethods": [
"CARD"
],
"successUrl": "<string>",
"cancelUrl": "<string>",
"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": "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).
Headers
Optional key (≤255 chars, e.g. a UUID v4) making this POST safe to retry · the response is cached 24h and a retry with the SAME key replays it instead of re-executing. The same key with a different body → 422 IDEMPOTENCY_KEY_CONFLICT; a retry while the first is in flight → 409.
Maximum string length:
255Example:
"5f3b9c2e-1a4d-4f2b-9c31-7e2a1b6d8c04"
Body
application/json
Shown at checkout, snapshotted onto every Payment.
Maximum string length:
200Maximum string length:
2000Public https URL.
ACTIVE sellable · DRAFT hidden from checkout · ARCHIVED retired.
Available options:
DRAFT, ACTIVE, ARCHIVED onetime and subscription carry the price on the product · pay_as_you_go carries none (each charge names its own priceCents), only a currency. subscription requires recurringInterval, the others refuse it.
Available options:
onetime, subscription, pay_as_you_go Minor units as a string of digits · "1999" = 19.99, at least "100" (1.00). Required with currency on an ACTIVE onetime / subscription; refused on pay_as_you_go.
Pattern:
^\d+$Required with priceCents, and alone on pay_as_you_go · a product bills in exactly one currency.
Available options:
EUR, USD Cadence · required when billingMode: subscription, refused otherwise.
Available options:
DAY, WEEK, MONTH, YEAR Multiplies the interval (MONTH ×3 = quarterly).
Required range:
x >= 1Auto-expire after N cycles. Null = renews indefinitely.
Required range:
x >= 1Stock cap; null = unlimited.
Required range:
x >= 0MoR VAT · exclusive prices HT and adds VAT on top, inclusive prices TTC. The default for every charge on this product; a charge may override it. Inert when no VAT applies.
Available options:
inclusive, exclusive Extra 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, ALMA, BILLIE, SCALAPAY, MULTIBANCO, PAYPAL, SEPA_DIRECT_DEBIT, ACH_DIRECT_DEBIT, STABLECOIN, VOLATILE_CRYPTO Redirect after payment. Null → Suby's confirmation page.
Back-button target on the hosted checkout.
Was this page helpful?