Create Product

POST

products

Create Product

curl --request POST \
  --url https://api.getruba.com/v1/products/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "prices": [
    {
      "amount_type": "<string>",
      "price_amount": 1,
      "price_currency": "usd"
    }
  ],
  "metadata": {},
  "description": "<string>",
  "visibility": "public",
  "medias": [
    "<string>"
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "required": true
    }
  ],
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "trial_interval_count": 500,
  "recurring_interval_count": 1
}
'

import requests

url = "https://api.getruba.com/v1/products/"

payload = {
    "name": "<string>",
    "prices": [
        {
            "amount_type": "<string>",
            "price_amount": 1,
            "price_currency": "usd"
        }
    ],
    "metadata": {},
    "description": "<string>",
    "visibility": "public",
    "medias": ["<string>"],
    "attached_custom_fields": [
        {
            "custom_field_id": "<string>",
            "required": True
        }
    ],
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "trial_interval_count": 500,
    "recurring_interval_count": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    prices: [{amount_type: '<string>', price_amount: 1, price_currency: 'usd'}],
    metadata: {},
    description: '<string>',
    visibility: 'public',
    medias: ['<string>'],
    attached_custom_fields: [{custom_field_id: '<string>', required: true}],
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    trial_interval_count: 500,
    recurring_interval_count: 1
  })
};

fetch('https://api.getruba.com/v1/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.getruba.com/v1/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>',
    'prices' => [
        [
                'amount_type' => '<string>',
                'price_amount' => 1,
                'price_currency' => 'usd'
        ]
    ],
    'metadata' => [
        
    ],
    'description' => '<string>',
    'visibility' => 'public',
    'medias' => [
        '<string>'
    ],
    'attached_custom_fields' => [
        [
                'custom_field_id' => '<string>',
                'required' => true
        ]
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    'trial_interval_count' => 500,
    'recurring_interval_count' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.getruba.com/v1/products/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.getruba.com/v1/products/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/products/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval_count": 123,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval_count": 123,
  "is_recurring": true,
  "is_archived": true,
  "organization_id": "<string>",
  "metadata": {},
  "prices": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "amount_type": "<string>",
      "price_currency": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "price_amount": 123,
      "legacy": true
    }
  ],
  "benefits": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "is_deleted": true,
      "organization_id": "<string>",
      "metadata": {},
      "properties": {
        "note": "<string>"
      },
      "visibility_configurable": true
    }
  ],
  "medias": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "mime_type": "<string>",
      "size": 123,
      "storage_version": "<string>",
      "checksum_etag": "<string>",
      "checksum_sha256_base64": "<string>",
      "checksum_sha256_hex": "<string>",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "version": "<string>",
      "service": "<string>",
      "is_uploaded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "size_readable": "<string>",
      "public_url": "<string>"
    }
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "custom_field": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": {},
        "type": "<string>",
        "slug": "<string>",
        "name": "<string>",
        "organization_id": "<string>",
        "properties": {
          "form_label": "<string>",
          "form_help_text": "<string>",
          "form_placeholder": "<string>",
          "textarea": true,
          "min_length": 1073741823,
          "max_length": 1073741823
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Authentication: You can generate a Personal Access Token from your settings.

Body

application/json

ProductCreateRecurring
ProductCreateOneTime

name

string

required

Customer-facing name assigned to the product.

Required string length: 3 - 64

prices

(ProductPriceFixedCreate · object | ProductPriceCustomCreate · object | ProductPriceSeatBasedCreate · object | ProductPriceMeteredUnitCreate · object)[]

required

Collection of available prices for this product. It may combine at most one fixed price with one seat-based price (billed as fixed + seat_charge), or contain a single custom or free price, plus any number of metered prices. A free price cannot be combined with other prices, and a custom price cannot be combined with a fixed or seat-based price. Metered prices are not supported on one-time purchase products.

Minimum array length: 1

Schema used to create a fixed price.

ProductPriceFixedCreate
ProductPriceCustomCreate
ProductPriceSeatBasedCreate
ProductPriceMeteredUnitCreate

Show child attributes

recurring_interval

enum<string>

required

Recurring Interval: Recurring interval of the product.

Available options:

day,

week,

month,

year

metadata

Metadata · object

Metadata map for information your integration needs to retain.

The key must be a string with a maximum length of 40 characters. The value must be either:

A string with a maximum length of 500 characters
An integer
A floating-point number
A boolean

You can store up to 50 key-value pairs.

Show child attributes

description

string | null

Customer-facing description attached to the product.

visibility

enum<string>

default:public

Controls where customers can discover the product.

Available options:

draft,

private,

public

medias

string<uuid4>[] | null

Collection of file IDs. Each one must be on the same organization as the product, of type product_media and correctly uploaded.

attached_custom_fields

AttachedCustomFieldCreate · object[]

Collection of custom fields to attach.

Show child attributes

organization_id

string<uuid4> | null

Identifier of the organization.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

trial_interval

enum<string> | null

Unit used to measure the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

Length of the trial measured in the selected interval.

Required range: 1 <= x <= 1000

recurring_interval_count

integer

default:1

Count of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on.

Required range: 1 <= x <= 999

Response

Response: Product created.

Object representing product.

string<uuid4>

required

The stable identifier for this record.

created_at

string<date-time>

required

The time Ruba created this record.

modified_at

string<date-time> | null

required

The time this record last changed.

trial_interval

enum<string> | null

required

Unit used to measure the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

required

Length of the trial measured in the selected interval.

name

string

required

Customer-facing name assigned to the product.

description

string | null

required

Customer-facing description attached to the product.

visibility

enum<string>

required

Controls where customers can discover the product.

Available options:

draft,

private,

public

recurring_interval

enum<string> | null

required

Recurring Interval: Recurring interval of the product. If None, the product is a one-time purchase.

Available options:

day,

week,

month,

year

recurring_interval_count

integer | null

required

Count of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.

is_recurring

boolean

required

Indicates whether the product is a subscription.

is_archived

boolean

required

Indicates whether the product is archived and no longer available.

organization_id

string<uuid4>

required

Unique identifier for the organization owning the product.

metadata

object

required

Show child attributes

prices

required

Collection of prices for this product.

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

Show child attributes

benefits

required

Collection of benefits granted by the product.

A benefit of type custom.

Use it to grant any kind of benefit that doesn't fit in the other types.

Show child attributes

medias

ProductMediaFileRead · object[]

required

Collection of medias associated to the product.

Show child attributes

attached_custom_fields

AttachedCustomField · object[]

required

Collection of custom fields attached to the product.

Show child attributes

Change Product Benefits### Intent Runs the change product benefits action. ### When to call it Call this when your workflow reaches the point where it must change product benefits. ### Access boundary Authorize the request with a token that carries `products:write`. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives.

⌘I

Create Product

curl --request POST \
  --url https://api.getruba.com/v1/products/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "prices": [
    {
      "amount_type": "<string>",
      "price_amount": 1,
      "price_currency": "usd"
    }
  ],
  "metadata": {},
  "description": "<string>",
  "visibility": "public",
  "medias": [
    "<string>"
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "required": true
    }
  ],
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "trial_interval_count": 500,
  "recurring_interval_count": 1
}
'

import requests

url = "https://api.getruba.com/v1/products/"

payload = {
    "name": "<string>",
    "prices": [
        {
            "amount_type": "<string>",
            "price_amount": 1,
            "price_currency": "usd"
        }
    ],
    "metadata": {},
    "description": "<string>",
    "visibility": "public",
    "medias": ["<string>"],
    "attached_custom_fields": [
        {
            "custom_field_id": "<string>",
            "required": True
        }
    ],
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "trial_interval_count": 500,
    "recurring_interval_count": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    prices: [{amount_type: '<string>', price_amount: 1, price_currency: 'usd'}],
    metadata: {},
    description: '<string>',
    visibility: 'public',
    medias: ['<string>'],
    attached_custom_fields: [{custom_field_id: '<string>', required: true}],
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    trial_interval_count: 500,
    recurring_interval_count: 1
  })
};

fetch('https://api.getruba.com/v1/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.getruba.com/v1/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>',
    'prices' => [
        [
                'amount_type' => '<string>',
                'price_amount' => 1,
                'price_currency' => 'usd'
        ]
    ],
    'metadata' => [
        
    ],
    'description' => '<string>',
    'visibility' => 'public',
    'medias' => [
        '<string>'
    ],
    'attached_custom_fields' => [
        [
                'custom_field_id' => '<string>',
                'required' => true
        ]
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    'trial_interval_count' => 500,
    'recurring_interval_count' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.getruba.com/v1/products/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.getruba.com/v1/products/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/products/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval_count": 123,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval_count": 123,
  "is_recurring": true,
  "is_archived": true,
  "organization_id": "<string>",
  "metadata": {},
  "prices": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "amount_type": "<string>",
      "price_currency": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "price_amount": 123,
      "legacy": true
    }
  ],
  "benefits": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "is_deleted": true,
      "organization_id": "<string>",
      "metadata": {},
      "properties": {
        "note": "<string>"
      },
      "visibility_configurable": true
    }
  ],
  "medias": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "mime_type": "<string>",
      "size": 123,
      "storage_version": "<string>",
      "checksum_etag": "<string>",
      "checksum_sha256_base64": "<string>",
      "checksum_sha256_hex": "<string>",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "version": "<string>",
      "service": "<string>",
      "is_uploaded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "size_readable": "<string>",
      "public_url": "<string>"
    }
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "custom_field": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": {},
        "type": "<string>",
        "slug": "<string>",
        "name": "<string>",
        "organization_id": "<string>",
        "properties": {
          "form_label": "<string>",
          "form_help_text": "<string>",
          "form_placeholder": "<string>",
          "textarea": true,
          "min_length": 1073741823,
          "max_length": 1073741823
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

Intent

When to call it

Access boundary

Successful result

Authorizations

Body

Response