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",
  "priceCents": "<string>",
  "recurringIntervalCount": 1,
  "recurringCycleCount": 2,
  "quantity": 1,
  "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",
    "priceCents": "<string>",
    "recurringIntervalCount": 1,
    "recurringCycleCount": 2,
    "quantity": 1,
    "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',
    priceCents: '<string>',
    recurringIntervalCount: 1,
    recurringCycleCount: 2,
    quantity: 1,
    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',
    'priceCents' => '<string>',
    'recurringIntervalCount' => 1,
    'recurringCycleCount' => 2,
    'quantity' => 1,
    '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  \"priceCents\": \"<string>\",\n  \"recurringIntervalCount\": 1,\n  \"recurringCycleCount\": 2,\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  \"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  \"priceCents\": \"<string>\",\n  \"recurringIntervalCount\": 1,\n  \"recurringCycleCount\": 2,\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  \"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  \"priceCents\": \"<string>\",\n  \"recurringIntervalCount\": 1,\n  \"recurringCycleCount\": 2,\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  \"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>",
    "priceCents": "<string>",
    "recurringIntervalCount": 123,
    "recurringCycleCount": 123,
    "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": [],
    "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"
      }
    ]
  }
}

POST

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",
  "priceCents": "<string>",
  "recurringIntervalCount": 1,
  "recurringCycleCount": 2,
  "quantity": 1,
  "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",
    "priceCents": "<string>",
    "recurringIntervalCount": 1,
    "recurringCycleCount": 2,
    "quantity": 1,
    "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',
    priceCents: '<string>',
    recurringIntervalCount: 1,
    recurringCycleCount: 2,
    quantity: 1,
    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',
    'priceCents' => '<string>',
    'recurringIntervalCount' => 1,
    'recurringCycleCount' => 2,
    'quantity' => 1,
    '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  \"priceCents\": \"<string>\",\n  \"recurringIntervalCount\": 1,\n  \"recurringCycleCount\": 2,\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  \"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  \"priceCents\": \"<string>\",\n  \"recurringIntervalCount\": 1,\n  \"recurringCycleCount\": 2,\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  \"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  \"priceCents\": \"<string>\",\n  \"recurringIntervalCount\": 1,\n  \"recurringCycleCount\": 2,\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  \"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>",
    "priceCents": "<string>",
    "recurringIntervalCount": 123,
    "recurringCycleCount": 123,
    "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": [],
    "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

X-Suby-Api-Key

string

header

required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Body

application/json

name

string

required

Display name, shown at checkout and snapshotted onto every Payment. Required.

Maximum string length: 200

description

string | null

Optional long description (checkout + receipts).

Maximum string length: 2000

imageUrl

string<uri> | null

Optional public https image URL.

status

enum<string>

default:ACTIVE

ACTIVE = sellable at checkout (default) · DRAFT = created but hidden from checkout (publish later by flipping to ACTIVE) · ARCHIVED = retired.

Available options:

DRAFT,

ACTIVE,

ARCHIVED

priceCents

string | null

Price in the smallest currency unit as a STRING of digits (cents), e.g. "1999" = 19.99. Optional at create; REQUIRED (with currency) before the product can be sold.

Pattern: ^\d+$

currency

enum<string> | null

ISO 4217 currency. Required alongside priceCents.

Available options:

EUR,

USD

recurringInterval

enum<string> | null

Set to make this a SUBSCRIPTION product; omit for a one-time product.

Available options:

DAY,

WEEK,

MONTH,

YEAR

recurringIntervalCount

integer

default:1

Multiplies the interval (e.g. MONTH ×3 = quarterly). Only meaningful with recurringInterval.

Required range: x >= 1

recurringCycleCount

integer | null

Caps the number of renewal cycles: null = renews indefinitely; N = the subscription auto-expires after N cycles (enforced by the renewal worker).

Required range: x >= 1

quantity

integer | null

Optional stock cap; omit/null = unlimited.

Required range: x >= 0

customFields

object[]

Extra fields collected on the hosted checkout page (max 10).

Maximum array length: 10

Show child attributes

paymentMethods

enum<string>[] | null

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

successUrl

string<uri> | null

After-payment redirect for this product's hosted checkout. Null → Suby's generic confirmation page.

cancelUrl

string<uri> | null

Back-button target on the hosted checkout.

Response

Product created

success

boolean

required

Example:

true

data

object

required

Endpoint-specific payload.

Show child attributes

message

string

List products Retrieve a product

Overview

Endpoints

Create a product

Authorizations

Body

Response