Create dimensional price group prices

curl --request POST \
  --url https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "item_id": "<string>",
  "currency": "USD",
  "prices": [
    {
      "dimension_values": [
        "<string>"
      ],
      "amounts": [
        123
      ],
      "name": "<string>"
    }
  ],
  "tiers": [
    {
      "first_unit": 123,
      "last_unit": 123
    }
  ]
}
'

import requests

url = "https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices"

payload = {
    "item_id": "<string>",
    "currency": "USD",
    "prices": [
        {
            "dimension_values": ["<string>"],
            "amounts": [123],
            "name": "<string>"
        }
    ],
    "tiers": [
        {
            "first_unit": 123,
            "last_unit": 123
        }
    ]
}
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({
    item_id: '<string>',
    currency: 'USD',
    prices: [{dimension_values: ['<string>'], amounts: [123], name: '<string>'}],
    tiers: [{first_unit: 123, last_unit: 123}]
  })
};

fetch('https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices', 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.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices",
  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([
    'item_id' => '<string>',
    'currency' => 'USD',
    'prices' => [
        [
                'dimension_values' => [
                                '<string>'
                ],
                'amounts' => [
                                123
                ],
                'name' => '<string>'
        ]
    ],
    'tiers' => [
        [
                'first_unit' => 123,
                'last_unit' => 123
        ]
    ]
  ]),
  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.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices"

	payload := strings.NewReader("{\n  \"item_id\": \"<string>\",\n  \"currency\": \"USD\",\n  \"prices\": [\n    {\n      \"dimension_values\": [\n        \"<string>\"\n      ],\n      \"amounts\": [\n        123\n      ],\n      \"name\": \"<string>\"\n    }\n  ],\n  \"tiers\": [\n    {\n      \"first_unit\": 123,\n      \"last_unit\": 123\n    }\n  ]\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.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_id\": \"<string>\",\n  \"currency\": \"USD\",\n  \"prices\": [\n    {\n      \"dimension_values\": [\n        \"<string>\"\n      ],\n      \"amounts\": [\n        123\n      ],\n      \"name\": \"<string>\"\n    }\n  ],\n  \"tiers\": [\n    {\n      \"first_unit\": 123,\n      \"last_unit\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices")

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  \"item_id\": \"<string>\",\n  \"currency\": \"USD\",\n  \"prices\": [\n    {\n      \"dimension_values\": [\n        \"<string>\"\n      ],\n      \"amounts\": [\n        123\n      ],\n      \"name\": \"<string>\"\n    }\n  ],\n  \"tiers\": [\n    {\n      \"first_unit\": 123,\n      \"last_unit\": 123\n    }\n  ]\n}"

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

{
  "data": [
    {
      "model_type": "unit",
      "unit_config": {
        "unit_amount": "<string>",
        "scaling_factor": 123,
        "prorated": false
      },
      "metadata": {},
      "id": "<string>",
      "name": "<string>",
      "external_price_id": "<string>",
      "replaces_price_id": "<string>",
      "price_type": "usage_price",
      "created_at": "2023-11-07T05:31:56Z",
      "cadence": "one_time",
      "billing_mode": "in_advance",
      "billing_cycle_configuration": {
        "duration": 123,
        "duration_unit": "day"
      },
      "invoicing_cycle_configuration": {
        "duration": 123,
        "duration_unit": "day"
      },
      "billable_metric": {
        "id": "<string>"
      },
      "fixed_price_quantity": 123,
      "plan_phase_order": 123,
      "currency": "<string>",
      "conversion_rate": 123,
      "conversion_rate_config": {
        "conversion_rate_type": "unit",
        "unit_config": {
          "unit_amount": "<string>"
        }
      },
      "item": {
        "id": "<string>",
        "name": "<string>"
      },
      "credit_allocation": {
        "currency": "<string>",
        "allows_rollover": true,
        "custom_expiration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "license_type_id": "<string>"
      },
      "composite_price_filters": [
        {
          "field": "price_id",
          "operator": "includes",
          "values": [
            "<string>"
          ]
        }
      ],
      "invoice_grouping_key": "<string>",
      "discount": {
        "discount_type": "percentage",
        "percentage_discount": 0.15,
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "reason": "<string>"
      },
      "minimum": {
        "minimum_amount": "<string>",
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "minimum_amount": "<string>",
      "maximum": {
        "maximum_amount": "<string>",
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "maximum_amount": "<string>",
      "dimensional_price_configuration": {
        "dimensional_price_group_id": "<string>",
        "dimension_values": [
          "<string>"
        ]
      },
      "license_type": {
        "id": "<string>",
        "name": "<string>",
        "grouping_key": "<string>"
      }
    }
  ]
}

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#404-feature-not-available",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#413-request-too-large",
  "status": 413,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 123,
  "detail": "<string>",
  "title": "<string>"
}

POST

dimensional_price_groups

{dimensional_price_group_id}

prices

Create dimensional price group prices

curl --request POST \
  --url https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "item_id": "<string>",
  "currency": "USD",
  "prices": [
    {
      "dimension_values": [
        "<string>"
      ],
      "amounts": [
        123
      ],
      "name": "<string>"
    }
  ],
  "tiers": [
    {
      "first_unit": 123,
      "last_unit": 123
    }
  ]
}
'

import requests

url = "https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices"

payload = {
    "item_id": "<string>",
    "currency": "USD",
    "prices": [
        {
            "dimension_values": ["<string>"],
            "amounts": [123],
            "name": "<string>"
        }
    ],
    "tiers": [
        {
            "first_unit": 123,
            "last_unit": 123
        }
    ]
}
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({
    item_id: '<string>',
    currency: 'USD',
    prices: [{dimension_values: ['<string>'], amounts: [123], name: '<string>'}],
    tiers: [{first_unit: 123, last_unit: 123}]
  })
};

fetch('https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices', 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.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices",
  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([
    'item_id' => '<string>',
    'currency' => 'USD',
    'prices' => [
        [
                'dimension_values' => [
                                '<string>'
                ],
                'amounts' => [
                                123
                ],
                'name' => '<string>'
        ]
    ],
    'tiers' => [
        [
                'first_unit' => 123,
                'last_unit' => 123
        ]
    ]
  ]),
  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.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices"

	payload := strings.NewReader("{\n  \"item_id\": \"<string>\",\n  \"currency\": \"USD\",\n  \"prices\": [\n    {\n      \"dimension_values\": [\n        \"<string>\"\n      ],\n      \"amounts\": [\n        123\n      ],\n      \"name\": \"<string>\"\n    }\n  ],\n  \"tiers\": [\n    {\n      \"first_unit\": 123,\n      \"last_unit\": 123\n    }\n  ]\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.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_id\": \"<string>\",\n  \"currency\": \"USD\",\n  \"prices\": [\n    {\n      \"dimension_values\": [\n        \"<string>\"\n      ],\n      \"amounts\": [\n        123\n      ],\n      \"name\": \"<string>\"\n    }\n  ],\n  \"tiers\": [\n    {\n      \"first_unit\": 123,\n      \"last_unit\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withorb.com/v1/dimensional_price_groups/{dimensional_price_group_id}/prices")

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  \"item_id\": \"<string>\",\n  \"currency\": \"USD\",\n  \"prices\": [\n    {\n      \"dimension_values\": [\n        \"<string>\"\n      ],\n      \"amounts\": [\n        123\n      ],\n      \"name\": \"<string>\"\n    }\n  ],\n  \"tiers\": [\n    {\n      \"first_unit\": 123,\n      \"last_unit\": 123\n    }\n  ]\n}"

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

{
  "data": [
    {
      "model_type": "unit",
      "unit_config": {
        "unit_amount": "<string>",
        "scaling_factor": 123,
        "prorated": false
      },
      "metadata": {},
      "id": "<string>",
      "name": "<string>",
      "external_price_id": "<string>",
      "replaces_price_id": "<string>",
      "price_type": "usage_price",
      "created_at": "2023-11-07T05:31:56Z",
      "cadence": "one_time",
      "billing_mode": "in_advance",
      "billing_cycle_configuration": {
        "duration": 123,
        "duration_unit": "day"
      },
      "invoicing_cycle_configuration": {
        "duration": 123,
        "duration_unit": "day"
      },
      "billable_metric": {
        "id": "<string>"
      },
      "fixed_price_quantity": 123,
      "plan_phase_order": 123,
      "currency": "<string>",
      "conversion_rate": 123,
      "conversion_rate_config": {
        "conversion_rate_type": "unit",
        "unit_config": {
          "unit_amount": "<string>"
        }
      },
      "item": {
        "id": "<string>",
        "name": "<string>"
      },
      "credit_allocation": {
        "currency": "<string>",
        "allows_rollover": true,
        "custom_expiration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "license_type_id": "<string>"
      },
      "composite_price_filters": [
        {
          "field": "price_id",
          "operator": "includes",
          "values": [
            "<string>"
          ]
        }
      ],
      "invoice_grouping_key": "<string>",
      "discount": {
        "discount_type": "percentage",
        "percentage_discount": 0.15,
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "reason": "<string>"
      },
      "minimum": {
        "minimum_amount": "<string>",
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "minimum_amount": "<string>",
      "maximum": {
        "maximum_amount": "<string>",
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ],
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "maximum_amount": "<string>",
      "dimensional_price_configuration": {
        "dimensional_price_group_id": "<string>",
        "dimension_values": [
          "<string>"
        ]
      },
      "license_type": {
        "id": "<string>",
        "name": "<string>",
        "grouping_key": "<string>"
      }
    }
  ]
}

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#404-feature-not-available",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#413-request-too-large",
  "status": 413,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 123,
  "detail": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

dimensional_price_group_id

string

required

Body

application/json

item_id

string

required

The item for every price. Must be the group's billable metric item.

cadence

enum<string>

required

Billing cadence for every price

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual

currency

string

required

An ISO 4217 currency string for every price.

Example:

"USD"

model_type

enum<string>

required

Available options:

unit,

tiered

prices

BulkDimensionalPrice · object[]

required

Minimum array length: 1

Show child attributes

tiers

DimensionalPriceTierBoundary · object[] | null

Shared tier boundaries. Required for tiered prices and omitted for unit prices.

Show child attributes

Response

Created

data

required

The prices created by this request, in request order.

The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.

Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.

For more on the types of prices, see the core concepts documentation

Show child attributes

API documentation

Webhooks

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

LicenseType

License

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Create dimensional price group prices

Authorizations

Path Parameters

Body

Response