Skip to main content
POST
/
plans
/
{plan_id}
/
versions
Create plan version
curl --request POST \
  --url https://api.withorb.com/v1/plans/{plan_id}/versions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "add_prices": [
    {
      "price": {
        "model_type": "unit",
        "unit_config": {
          "unit_amount": "<string>",
          "prorated": false
        },
        "name": "<string>",
        "item_id": "<string>",
        "metadata": {},
        "external_price_id": "<string>",
        "dimensional_price_configuration": {
          "dimension_values": [
            "<string>"
          ],
          "dimensional_price_group_id": "<string>",
          "external_dimensional_price_group_id": "<string>"
        },
        "license_type_id": "<string>",
        "billable_metric_id": "<string>",
        "billed_in_advance": true,
        "fixed_price_quantity": 123,
        "invoice_grouping_key": "<string>",
        "billing_cycle_configuration": {
          "duration": 123
        },
        "invoicing_cycle_configuration": {
          "duration": 123
        },
        "conversion_rate": 123,
        "conversion_rate_config": {
          "conversion_rate_type": "unit",
          "unit_config": {
            "unit_amount": "<string>"
          }
        },
        "currency": "<string>",
        "reference_id": "<string>"
      },
      "allocation_price": {
        "currency": "<string>",
        "amount": "<string>",
        "metadata": {},
        "expires_at_end_of_cadence": true,
        "custom_expiration": {
          "duration": 123
        },
        "filters": [
          {
            "field": "item_id",
            "values": [
              "<string>"
            ]
          }
        ],
        "per_unit_cost_basis": "0.00",
        "item_id": "<string>",
        "license_type_id": "<string>"
      },
      "license_allocation_price": {
        "model_type": "unit",
        "unit_config": {
          "unit_amount": "<string>",
          "prorated": false
        },
        "name": "<string>",
        "item_id": "<string>",
        "license_allocations": [
          {
            "currency": "<string>",
            "amount": "<string>",
            "write_off_overage": true
          }
        ],
        "metadata": {},
        "external_price_id": "<string>",
        "dimensional_price_configuration": {
          "dimension_values": [
            "<string>"
          ],
          "dimensional_price_group_id": "<string>",
          "external_dimensional_price_group_id": "<string>"
        },
        "license_type_id": "<string>",
        "billable_metric_id": "<string>",
        "billed_in_advance": true,
        "fixed_price_quantity": 123,
        "invoice_grouping_key": "<string>",
        "billing_cycle_configuration": {
          "duration": 123
        },
        "invoicing_cycle_configuration": {
          "duration": 123
        },
        "conversion_rate": 123,
        "conversion_rate_config": {
          "conversion_rate_type": "unit",
          "unit_config": {
            "unit_amount": "<string>"
          }
        },
        "currency": "<string>",
        "reference_id": "<string>"
      },
      "plan_phase_order": 123
    }
  ],
  "remove_prices": [
    {
      "price_id": "<string>",
      "plan_phase_order": 123
    }
  ],
  "replace_prices": [
    {
      "replaces_price_id": "<string>",
      "price": {
        "model_type": "unit",
        "unit_config": {
          "unit_amount": "<string>",
          "prorated": false
        },
        "name": "<string>",
        "item_id": "<string>",
        "metadata": {},
        "external_price_id": "<string>",
        "dimensional_price_configuration": {
          "dimension_values": [
            "<string>"
          ],
          "dimensional_price_group_id": "<string>",
          "external_dimensional_price_group_id": "<string>"
        },
        "license_type_id": "<string>",
        "billable_metric_id": "<string>",
        "billed_in_advance": true,
        "fixed_price_quantity": 123,
        "invoice_grouping_key": "<string>",
        "billing_cycle_configuration": {
          "duration": 123
        },
        "invoicing_cycle_configuration": {
          "duration": 123
        },
        "conversion_rate": 123,
        "conversion_rate_config": {
          "conversion_rate_type": "unit",
          "unit_config": {
            "unit_amount": "<string>"
          }
        },
        "currency": "<string>",
        "reference_id": "<string>"
      },
      "allocation_price": {
        "currency": "<string>",
        "amount": "<string>",
        "metadata": {},
        "expires_at_end_of_cadence": true,
        "custom_expiration": {
          "duration": 123
        },
        "filters": [
          {
            "field": "item_id",
            "values": [
              "<string>"
            ]
          }
        ],
        "per_unit_cost_basis": "0.00",
        "item_id": "<string>",
        "license_type_id": "<string>"
      },
      "license_allocation_price": {
        "model_type": "unit",
        "unit_config": {
          "unit_amount": "<string>",
          "prorated": false
        },
        "name": "<string>",
        "item_id": "<string>",
        "license_allocations": [
          {
            "currency": "<string>",
            "amount": "<string>",
            "write_off_overage": true
          }
        ],
        "metadata": {},
        "external_price_id": "<string>",
        "dimensional_price_configuration": {
          "dimension_values": [
            "<string>"
          ],
          "dimensional_price_group_id": "<string>",
          "external_dimensional_price_group_id": "<string>"
        },
        "license_type_id": "<string>",
        "billable_metric_id": "<string>",
        "billed_in_advance": true,
        "fixed_price_quantity": 123,
        "invoice_grouping_key": "<string>",
        "billing_cycle_configuration": {
          "duration": 123
        },
        "invoicing_cycle_configuration": {
          "duration": 123
        },
        "conversion_rate": 123,
        "conversion_rate_config": {
          "conversion_rate_type": "unit",
          "unit_config": {
            "unit_amount": "<string>"
          }
        },
        "currency": "<string>",
        "reference_id": "<string>"
      },
      "plan_phase_order": 123
    }
  ],
  "add_adjustments": [
    {
      "adjustment": {
        "adjustment_type": "percentage_discount",
        "percentage_discount": 123,
        "applies_to_price_ids": [
          "price_1",
          "price_2"
        ],
        "applies_to_item_ids": [
          "item_1",
          "item_2"
        ],
        "applies_to_all": true,
        "filters": [
          {
            "values": [
              "<string>"
            ]
          }
        ],
        "currency": [
          "USD",
          "JPY",
          "credits"
        ],
        "is_invoice_level": true
      },
      "plan_phase_order": 123
    }
  ],
  "remove_adjustments": [
    {
      "adjustment_id": "<string>",
      "plan_phase_order": 123
    }
  ],
  "replace_adjustments": [
    {
      "adjustment": {
        "adjustment_type": "percentage_discount",
        "percentage_discount": 123,
        "applies_to_price_ids": [
          "price_1",
          "price_2"
        ],
        "applies_to_item_ids": [
          "item_1",
          "item_2"
        ],
        "applies_to_all": true,
        "filters": [
          {
            "values": [
              "<string>"
            ]
          }
        ],
        "currency": [
          "USD",
          "JPY",
          "credits"
        ],
        "is_invoice_level": true
      },
      "replaces_adjustment_id": "<string>",
      "plan_phase_order": 123
    }
  ],
  "set_as_default": true
}
'
import requests

url = "https://api.withorb.com/v1/plans/{plan_id}/versions"

payload = {
"version": 123,
"add_prices": [
{
"price": {
"model_type": "unit",
"unit_config": {
"unit_amount": "<string>",
"prorated": False
},
"name": "<string>",
"item_id": "<string>",
"metadata": {},
"external_price_id": "<string>",
"dimensional_price_configuration": {
"dimension_values": ["<string>"],
"dimensional_price_group_id": "<string>",
"external_dimensional_price_group_id": "<string>"
},
"license_type_id": "<string>",
"billable_metric_id": "<string>",
"billed_in_advance": True,
"fixed_price_quantity": 123,
"invoice_grouping_key": "<string>",
"billing_cycle_configuration": { "duration": 123 },
"invoicing_cycle_configuration": { "duration": 123 },
"conversion_rate": 123,
"conversion_rate_config": {
"conversion_rate_type": "unit",
"unit_config": { "unit_amount": "<string>" }
},
"currency": "<string>",
"reference_id": "<string>"
},
"allocation_price": {
"currency": "<string>",
"amount": "<string>",
"metadata": {},
"expires_at_end_of_cadence": True,
"custom_expiration": { "duration": 123 },
"filters": [
{
"field": "item_id",
"values": ["<string>"]
}
],
"per_unit_cost_basis": "0.00",
"item_id": "<string>",
"license_type_id": "<string>"
},
"license_allocation_price": {
"model_type": "unit",
"unit_config": {
"unit_amount": "<string>",
"prorated": False
},
"name": "<string>",
"item_id": "<string>",
"license_allocations": [
{
"currency": "<string>",
"amount": "<string>",
"write_off_overage": True
}
],
"metadata": {},
"external_price_id": "<string>",
"dimensional_price_configuration": {
"dimension_values": ["<string>"],
"dimensional_price_group_id": "<string>",
"external_dimensional_price_group_id": "<string>"
},
"license_type_id": "<string>",
"billable_metric_id": "<string>",
"billed_in_advance": True,
"fixed_price_quantity": 123,
"invoice_grouping_key": "<string>",
"billing_cycle_configuration": { "duration": 123 },
"invoicing_cycle_configuration": { "duration": 123 },
"conversion_rate": 123,
"conversion_rate_config": {
"conversion_rate_type": "unit",
"unit_config": { "unit_amount": "<string>" }
},
"currency": "<string>",
"reference_id": "<string>"
},
"plan_phase_order": 123
}
],
"remove_prices": [
{
"price_id": "<string>",
"plan_phase_order": 123
}
],
"replace_prices": [
{
"replaces_price_id": "<string>",
"price": {
"model_type": "unit",
"unit_config": {
"unit_amount": "<string>",
"prorated": False
},
"name": "<string>",
"item_id": "<string>",
"metadata": {},
"external_price_id": "<string>",
"dimensional_price_configuration": {
"dimension_values": ["<string>"],
"dimensional_price_group_id": "<string>",
"external_dimensional_price_group_id": "<string>"
},
"license_type_id": "<string>",
"billable_metric_id": "<string>",
"billed_in_advance": True,
"fixed_price_quantity": 123,
"invoice_grouping_key": "<string>",
"billing_cycle_configuration": { "duration": 123 },
"invoicing_cycle_configuration": { "duration": 123 },
"conversion_rate": 123,
"conversion_rate_config": {
"conversion_rate_type": "unit",
"unit_config": { "unit_amount": "<string>" }
},
"currency": "<string>",
"reference_id": "<string>"
},
"allocation_price": {
"currency": "<string>",
"amount": "<string>",
"metadata": {},
"expires_at_end_of_cadence": True,
"custom_expiration": { "duration": 123 },
"filters": [
{
"field": "item_id",
"values": ["<string>"]
}
],
"per_unit_cost_basis": "0.00",
"item_id": "<string>",
"license_type_id": "<string>"
},
"license_allocation_price": {
"model_type": "unit",
"unit_config": {
"unit_amount": "<string>",
"prorated": False
},
"name": "<string>",
"item_id": "<string>",
"license_allocations": [
{
"currency": "<string>",
"amount": "<string>",
"write_off_overage": True
}
],
"metadata": {},
"external_price_id": "<string>",
"dimensional_price_configuration": {
"dimension_values": ["<string>"],
"dimensional_price_group_id": "<string>",
"external_dimensional_price_group_id": "<string>"
},
"license_type_id": "<string>",
"billable_metric_id": "<string>",
"billed_in_advance": True,
"fixed_price_quantity": 123,
"invoice_grouping_key": "<string>",
"billing_cycle_configuration": { "duration": 123 },
"invoicing_cycle_configuration": { "duration": 123 },
"conversion_rate": 123,
"conversion_rate_config": {
"conversion_rate_type": "unit",
"unit_config": { "unit_amount": "<string>" }
},
"currency": "<string>",
"reference_id": "<string>"
},
"plan_phase_order": 123
}
],
"add_adjustments": [
{
"adjustment": {
"adjustment_type": "percentage_discount",
"percentage_discount": 123,
"applies_to_price_ids": ["price_1", "price_2"],
"applies_to_item_ids": ["item_1", "item_2"],
"applies_to_all": True,
"filters": [{ "values": ["<string>"] }],
"currency": ["USD", "JPY", "credits"],
"is_invoice_level": True
},
"plan_phase_order": 123
}
],
"remove_adjustments": [
{
"adjustment_id": "<string>",
"plan_phase_order": 123
}
],
"replace_adjustments": [
{
"adjustment": {
"adjustment_type": "percentage_discount",
"percentage_discount": 123,
"applies_to_price_ids": ["price_1", "price_2"],
"applies_to_item_ids": ["item_1", "item_2"],
"applies_to_all": True,
"filters": [{ "values": ["<string>"] }],
"currency": ["USD", "JPY", "credits"],
"is_invoice_level": True
},
"replaces_adjustment_id": "<string>",
"plan_phase_order": 123
}
],
"set_as_default": True
}
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({
version: 123,
add_prices: [
{
price: {
model_type: 'unit',
unit_config: {unit_amount: '<string>', prorated: false},
name: '<string>',
item_id: '<string>',
metadata: {},
external_price_id: '<string>',
dimensional_price_configuration: {
dimension_values: ['<string>'],
dimensional_price_group_id: '<string>',
external_dimensional_price_group_id: '<string>'
},
license_type_id: '<string>',
billable_metric_id: '<string>',
billed_in_advance: true,
fixed_price_quantity: 123,
invoice_grouping_key: '<string>',
billing_cycle_configuration: {duration: 123},
invoicing_cycle_configuration: {duration: 123},
conversion_rate: 123,
conversion_rate_config: {conversion_rate_type: 'unit', unit_config: {unit_amount: '<string>'}},
currency: '<string>',
reference_id: '<string>'
},
allocation_price: {
currency: '<string>',
amount: '<string>',
metadata: {},
expires_at_end_of_cadence: true,
custom_expiration: {duration: 123},
filters: [{field: 'item_id', values: ['<string>']}],
per_unit_cost_basis: '0.00',
item_id: '<string>',
license_type_id: '<string>'
},
license_allocation_price: {
model_type: 'unit',
unit_config: {unit_amount: '<string>', prorated: false},
name: '<string>',
item_id: '<string>',
license_allocations: [{currency: '<string>', amount: '<string>', write_off_overage: true}],
metadata: {},
external_price_id: '<string>',
dimensional_price_configuration: {
dimension_values: ['<string>'],
dimensional_price_group_id: '<string>',
external_dimensional_price_group_id: '<string>'
},
license_type_id: '<string>',
billable_metric_id: '<string>',
billed_in_advance: true,
fixed_price_quantity: 123,
invoice_grouping_key: '<string>',
billing_cycle_configuration: {duration: 123},
invoicing_cycle_configuration: {duration: 123},
conversion_rate: 123,
conversion_rate_config: {conversion_rate_type: 'unit', unit_config: {unit_amount: '<string>'}},
currency: '<string>',
reference_id: '<string>'
},
plan_phase_order: 123
}
],
remove_prices: [{price_id: '<string>', plan_phase_order: 123}],
replace_prices: [
{
replaces_price_id: '<string>',
price: {
model_type: 'unit',
unit_config: {unit_amount: '<string>', prorated: false},
name: '<string>',
item_id: '<string>',
metadata: {},
external_price_id: '<string>',
dimensional_price_configuration: {
dimension_values: ['<string>'],
dimensional_price_group_id: '<string>',
external_dimensional_price_group_id: '<string>'
},
license_type_id: '<string>',
billable_metric_id: '<string>',
billed_in_advance: true,
fixed_price_quantity: 123,
invoice_grouping_key: '<string>',
billing_cycle_configuration: {duration: 123},
invoicing_cycle_configuration: {duration: 123},
conversion_rate: 123,
conversion_rate_config: {conversion_rate_type: 'unit', unit_config: {unit_amount: '<string>'}},
currency: '<string>',
reference_id: '<string>'
},
allocation_price: {
currency: '<string>',
amount: '<string>',
metadata: {},
expires_at_end_of_cadence: true,
custom_expiration: {duration: 123},
filters: [{field: 'item_id', values: ['<string>']}],
per_unit_cost_basis: '0.00',
item_id: '<string>',
license_type_id: '<string>'
},
license_allocation_price: {
model_type: 'unit',
unit_config: {unit_amount: '<string>', prorated: false},
name: '<string>',
item_id: '<string>',
license_allocations: [{currency: '<string>', amount: '<string>', write_off_overage: true}],
metadata: {},
external_price_id: '<string>',
dimensional_price_configuration: {
dimension_values: ['<string>'],
dimensional_price_group_id: '<string>',
external_dimensional_price_group_id: '<string>'
},
license_type_id: '<string>',
billable_metric_id: '<string>',
billed_in_advance: true,
fixed_price_quantity: 123,
invoice_grouping_key: '<string>',
billing_cycle_configuration: {duration: 123},
invoicing_cycle_configuration: {duration: 123},
conversion_rate: 123,
conversion_rate_config: {conversion_rate_type: 'unit', unit_config: {unit_amount: '<string>'}},
currency: '<string>',
reference_id: '<string>'
},
plan_phase_order: 123
}
],
add_adjustments: [
{
adjustment: {
adjustment_type: 'percentage_discount',
percentage_discount: 123,
applies_to_price_ids: ['price_1', 'price_2'],
applies_to_item_ids: ['item_1', 'item_2'],
applies_to_all: true,
filters: [{values: ['<string>']}],
currency: ['USD', 'JPY', 'credits'],
is_invoice_level: true
},
plan_phase_order: 123
}
],
remove_adjustments: [{adjustment_id: '<string>', plan_phase_order: 123}],
replace_adjustments: [
{
adjustment: {
adjustment_type: 'percentage_discount',
percentage_discount: 123,
applies_to_price_ids: ['price_1', 'price_2'],
applies_to_item_ids: ['item_1', 'item_2'],
applies_to_all: true,
filters: [{values: ['<string>']}],
currency: ['USD', 'JPY', 'credits'],
is_invoice_level: true
},
replaces_adjustment_id: '<string>',
plan_phase_order: 123
}
],
set_as_default: true
})
};

fetch('https://api.withorb.com/v1/plans/{plan_id}/versions', 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/plans/{plan_id}/versions",
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([
'version' => 123,
'add_prices' => [
[
'price' => [
'model_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>',
'prorated' => false
],
'name' => '<string>',
'item_id' => '<string>',
'metadata' => [

],
'external_price_id' => '<string>',
'dimensional_price_configuration' => [
'dimension_values' => [
'<string>'
],
'dimensional_price_group_id' => '<string>',
'external_dimensional_price_group_id' => '<string>'
],
'license_type_id' => '<string>',
'billable_metric_id' => '<string>',
'billed_in_advance' => true,
'fixed_price_quantity' => 123,
'invoice_grouping_key' => '<string>',
'billing_cycle_configuration' => [
'duration' => 123
],
'invoicing_cycle_configuration' => [
'duration' => 123
],
'conversion_rate' => 123,
'conversion_rate_config' => [
'conversion_rate_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>'
]
],
'currency' => '<string>',
'reference_id' => '<string>'
],
'allocation_price' => [
'currency' => '<string>',
'amount' => '<string>',
'metadata' => [

],
'expires_at_end_of_cadence' => true,
'custom_expiration' => [
'duration' => 123
],
'filters' => [
[
'field' => 'item_id',
'values' => [
'<string>'
]
]
],
'per_unit_cost_basis' => '0.00',
'item_id' => '<string>',
'license_type_id' => '<string>'
],
'license_allocation_price' => [
'model_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>',
'prorated' => false
],
'name' => '<string>',
'item_id' => '<string>',
'license_allocations' => [
[
'currency' => '<string>',
'amount' => '<string>',
'write_off_overage' => true
]
],
'metadata' => [

],
'external_price_id' => '<string>',
'dimensional_price_configuration' => [
'dimension_values' => [
'<string>'
],
'dimensional_price_group_id' => '<string>',
'external_dimensional_price_group_id' => '<string>'
],
'license_type_id' => '<string>',
'billable_metric_id' => '<string>',
'billed_in_advance' => true,
'fixed_price_quantity' => 123,
'invoice_grouping_key' => '<string>',
'billing_cycle_configuration' => [
'duration' => 123
],
'invoicing_cycle_configuration' => [
'duration' => 123
],
'conversion_rate' => 123,
'conversion_rate_config' => [
'conversion_rate_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>'
]
],
'currency' => '<string>',
'reference_id' => '<string>'
],
'plan_phase_order' => 123
]
],
'remove_prices' => [
[
'price_id' => '<string>',
'plan_phase_order' => 123
]
],
'replace_prices' => [
[
'replaces_price_id' => '<string>',
'price' => [
'model_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>',
'prorated' => false
],
'name' => '<string>',
'item_id' => '<string>',
'metadata' => [

],
'external_price_id' => '<string>',
'dimensional_price_configuration' => [
'dimension_values' => [
'<string>'
],
'dimensional_price_group_id' => '<string>',
'external_dimensional_price_group_id' => '<string>'
],
'license_type_id' => '<string>',
'billable_metric_id' => '<string>',
'billed_in_advance' => true,
'fixed_price_quantity' => 123,
'invoice_grouping_key' => '<string>',
'billing_cycle_configuration' => [
'duration' => 123
],
'invoicing_cycle_configuration' => [
'duration' => 123
],
'conversion_rate' => 123,
'conversion_rate_config' => [
'conversion_rate_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>'
]
],
'currency' => '<string>',
'reference_id' => '<string>'
],
'allocation_price' => [
'currency' => '<string>',
'amount' => '<string>',
'metadata' => [

],
'expires_at_end_of_cadence' => true,
'custom_expiration' => [
'duration' => 123
],
'filters' => [
[
'field' => 'item_id',
'values' => [
'<string>'
]
]
],
'per_unit_cost_basis' => '0.00',
'item_id' => '<string>',
'license_type_id' => '<string>'
],
'license_allocation_price' => [
'model_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>',
'prorated' => false
],
'name' => '<string>',
'item_id' => '<string>',
'license_allocations' => [
[
'currency' => '<string>',
'amount' => '<string>',
'write_off_overage' => true
]
],
'metadata' => [

],
'external_price_id' => '<string>',
'dimensional_price_configuration' => [
'dimension_values' => [
'<string>'
],
'dimensional_price_group_id' => '<string>',
'external_dimensional_price_group_id' => '<string>'
],
'license_type_id' => '<string>',
'billable_metric_id' => '<string>',
'billed_in_advance' => true,
'fixed_price_quantity' => 123,
'invoice_grouping_key' => '<string>',
'billing_cycle_configuration' => [
'duration' => 123
],
'invoicing_cycle_configuration' => [
'duration' => 123
],
'conversion_rate' => 123,
'conversion_rate_config' => [
'conversion_rate_type' => 'unit',
'unit_config' => [
'unit_amount' => '<string>'
]
],
'currency' => '<string>',
'reference_id' => '<string>'
],
'plan_phase_order' => 123
]
],
'add_adjustments' => [
[
'adjustment' => [
'adjustment_type' => 'percentage_discount',
'percentage_discount' => 123,
'applies_to_price_ids' => [
'price_1',
'price_2'
],
'applies_to_item_ids' => [
'item_1',
'item_2'
],
'applies_to_all' => true,
'filters' => [
[
'values' => [
'<string>'
]
]
],
'currency' => [
'USD',
'JPY',
'credits'
],
'is_invoice_level' => true
],
'plan_phase_order' => 123
]
],
'remove_adjustments' => [
[
'adjustment_id' => '<string>',
'plan_phase_order' => 123
]
],
'replace_adjustments' => [
[
'adjustment' => [
'adjustment_type' => 'percentage_discount',
'percentage_discount' => 123,
'applies_to_price_ids' => [
'price_1',
'price_2'
],
'applies_to_item_ids' => [
'item_1',
'item_2'
],
'applies_to_all' => true,
'filters' => [
[
'values' => [
'<string>'
]
]
],
'currency' => [
'USD',
'JPY',
'credits'
],
'is_invoice_level' => true
],
'replaces_adjustment_id' => '<string>',
'plan_phase_order' => 123
]
],
'set_as_default' => true
]),
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/plans/{plan_id}/versions"

payload := strings.NewReader("{\n \"version\": 123,\n \"add_prices\": [\n {\n \"price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"allocation_price\": {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {},\n \"expires_at_end_of_cadence\": true,\n \"custom_expiration\": {\n \"duration\": 123\n },\n \"filters\": [\n {\n \"field\": \"item_id\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"per_unit_cost_basis\": \"0.00\",\n \"item_id\": \"<string>\",\n \"license_type_id\": \"<string>\"\n },\n \"license_allocation_price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"license_allocations\": [\n {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"write_off_overage\": true\n }\n ],\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"plan_phase_order\": 123\n }\n ],\n \"remove_prices\": [\n {\n \"price_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"replace_prices\": [\n {\n \"replaces_price_id\": \"<string>\",\n \"price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"allocation_price\": {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {},\n \"expires_at_end_of_cadence\": true,\n \"custom_expiration\": {\n \"duration\": 123\n },\n \"filters\": [\n {\n \"field\": \"item_id\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"per_unit_cost_basis\": \"0.00\",\n \"item_id\": \"<string>\",\n \"license_type_id\": \"<string>\"\n },\n \"license_allocation_price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"license_allocations\": [\n {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"write_off_overage\": true\n }\n ],\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"plan_phase_order\": 123\n }\n ],\n \"add_adjustments\": [\n {\n \"adjustment\": {\n \"adjustment_type\": \"percentage_discount\",\n \"percentage_discount\": 123,\n \"applies_to_price_ids\": [\n \"price_1\",\n \"price_2\"\n ],\n \"applies_to_item_ids\": [\n \"item_1\",\n \"item_2\"\n ],\n \"applies_to_all\": true,\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"currency\": [\n \"USD\",\n \"JPY\",\n \"credits\"\n ],\n \"is_invoice_level\": true\n },\n \"plan_phase_order\": 123\n }\n ],\n \"remove_adjustments\": [\n {\n \"adjustment_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"replace_adjustments\": [\n {\n \"adjustment\": {\n \"adjustment_type\": \"percentage_discount\",\n \"percentage_discount\": 123,\n \"applies_to_price_ids\": [\n \"price_1\",\n \"price_2\"\n ],\n \"applies_to_item_ids\": [\n \"item_1\",\n \"item_2\"\n ],\n \"applies_to_all\": true,\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"currency\": [\n \"USD\",\n \"JPY\",\n \"credits\"\n ],\n \"is_invoice_level\": true\n },\n \"replaces_adjustment_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"set_as_default\": true\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/plans/{plan_id}/versions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"version\": 123,\n \"add_prices\": [\n {\n \"price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"allocation_price\": {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {},\n \"expires_at_end_of_cadence\": true,\n \"custom_expiration\": {\n \"duration\": 123\n },\n \"filters\": [\n {\n \"field\": \"item_id\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"per_unit_cost_basis\": \"0.00\",\n \"item_id\": \"<string>\",\n \"license_type_id\": \"<string>\"\n },\n \"license_allocation_price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"license_allocations\": [\n {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"write_off_overage\": true\n }\n ],\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"plan_phase_order\": 123\n }\n ],\n \"remove_prices\": [\n {\n \"price_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"replace_prices\": [\n {\n \"replaces_price_id\": \"<string>\",\n \"price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"allocation_price\": {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {},\n \"expires_at_end_of_cadence\": true,\n \"custom_expiration\": {\n \"duration\": 123\n },\n \"filters\": [\n {\n \"field\": \"item_id\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"per_unit_cost_basis\": \"0.00\",\n \"item_id\": \"<string>\",\n \"license_type_id\": \"<string>\"\n },\n \"license_allocation_price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"license_allocations\": [\n {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"write_off_overage\": true\n }\n ],\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"plan_phase_order\": 123\n }\n ],\n \"add_adjustments\": [\n {\n \"adjustment\": {\n \"adjustment_type\": \"percentage_discount\",\n \"percentage_discount\": 123,\n \"applies_to_price_ids\": [\n \"price_1\",\n \"price_2\"\n ],\n \"applies_to_item_ids\": [\n \"item_1\",\n \"item_2\"\n ],\n \"applies_to_all\": true,\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"currency\": [\n \"USD\",\n \"JPY\",\n \"credits\"\n ],\n \"is_invoice_level\": true\n },\n \"plan_phase_order\": 123\n }\n ],\n \"remove_adjustments\": [\n {\n \"adjustment_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"replace_adjustments\": [\n {\n \"adjustment\": {\n \"adjustment_type\": \"percentage_discount\",\n \"percentage_discount\": 123,\n \"applies_to_price_ids\": [\n \"price_1\",\n \"price_2\"\n ],\n \"applies_to_item_ids\": [\n \"item_1\",\n \"item_2\"\n ],\n \"applies_to_all\": true,\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"currency\": [\n \"USD\",\n \"JPY\",\n \"credits\"\n ],\n \"is_invoice_level\": true\n },\n \"replaces_adjustment_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"set_as_default\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.withorb.com/v1/plans/{plan_id}/versions")

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 \"version\": 123,\n \"add_prices\": [\n {\n \"price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"allocation_price\": {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {},\n \"expires_at_end_of_cadence\": true,\n \"custom_expiration\": {\n \"duration\": 123\n },\n \"filters\": [\n {\n \"field\": \"item_id\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"per_unit_cost_basis\": \"0.00\",\n \"item_id\": \"<string>\",\n \"license_type_id\": \"<string>\"\n },\n \"license_allocation_price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"license_allocations\": [\n {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"write_off_overage\": true\n }\n ],\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"plan_phase_order\": 123\n }\n ],\n \"remove_prices\": [\n {\n \"price_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"replace_prices\": [\n {\n \"replaces_price_id\": \"<string>\",\n \"price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"allocation_price\": {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {},\n \"expires_at_end_of_cadence\": true,\n \"custom_expiration\": {\n \"duration\": 123\n },\n \"filters\": [\n {\n \"field\": \"item_id\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"per_unit_cost_basis\": \"0.00\",\n \"item_id\": \"<string>\",\n \"license_type_id\": \"<string>\"\n },\n \"license_allocation_price\": {\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\",\n \"prorated\": false\n },\n \"name\": \"<string>\",\n \"item_id\": \"<string>\",\n \"license_allocations\": [\n {\n \"currency\": \"<string>\",\n \"amount\": \"<string>\",\n \"write_off_overage\": true\n }\n ],\n \"metadata\": {},\n \"external_price_id\": \"<string>\",\n \"dimensional_price_configuration\": {\n \"dimension_values\": [\n \"<string>\"\n ],\n \"dimensional_price_group_id\": \"<string>\",\n \"external_dimensional_price_group_id\": \"<string>\"\n },\n \"license_type_id\": \"<string>\",\n \"billable_metric_id\": \"<string>\",\n \"billed_in_advance\": true,\n \"fixed_price_quantity\": 123,\n \"invoice_grouping_key\": \"<string>\",\n \"billing_cycle_configuration\": {\n \"duration\": 123\n },\n \"invoicing_cycle_configuration\": {\n \"duration\": 123\n },\n \"conversion_rate\": 123,\n \"conversion_rate_config\": {\n \"conversion_rate_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"<string>\"\n }\n },\n \"currency\": \"<string>\",\n \"reference_id\": \"<string>\"\n },\n \"plan_phase_order\": 123\n }\n ],\n \"add_adjustments\": [\n {\n \"adjustment\": {\n \"adjustment_type\": \"percentage_discount\",\n \"percentage_discount\": 123,\n \"applies_to_price_ids\": [\n \"price_1\",\n \"price_2\"\n ],\n \"applies_to_item_ids\": [\n \"item_1\",\n \"item_2\"\n ],\n \"applies_to_all\": true,\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"currency\": [\n \"USD\",\n \"JPY\",\n \"credits\"\n ],\n \"is_invoice_level\": true\n },\n \"plan_phase_order\": 123\n }\n ],\n \"remove_adjustments\": [\n {\n \"adjustment_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"replace_adjustments\": [\n {\n \"adjustment\": {\n \"adjustment_type\": \"percentage_discount\",\n \"percentage_discount\": 123,\n \"applies_to_price_ids\": [\n \"price_1\",\n \"price_2\"\n ],\n \"applies_to_item_ids\": [\n \"item_1\",\n \"item_2\"\n ],\n \"applies_to_all\": true,\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"currency\": [\n \"USD\",\n \"JPY\",\n \"credits\"\n ],\n \"is_invoice_level\": true\n },\n \"replaces_adjustment_id\": \"<string>\",\n \"plan_phase_order\": 123\n }\n ],\n \"set_as_default\": true\n}"

response = http.request(request)
puts response.read_body
{
  "created_at": "2023-11-07T05:31:56Z",
  "version": 123,
  "plan_phases": [
    {
      "id": "<string>",
      "description": "<string>",
      "duration": 123,
      "name": "<string>",
      "order": 123
    }
  ],
  "prices": [
    {
      "model_type": "unit",
      "unit_config": {
        "unit_amount": "<string>",
        "prorated": false
      },
      "metadata": {},
      "id": "<string>",
      "name": "<string>",
      "external_price_id": "<string>",
      "replaces_price_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "billing_cycle_configuration": {
        "duration": 123
      },
      "invoicing_cycle_configuration": {
        "duration": 123
      },
      "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
        },
        "filters": [
          {
            "values": [
              "<string>"
            ]
          }
        ],
        "license_type_id": "<string>"
      },
      "composite_price_filters": [
        {
          "values": [
            "<string>"
          ]
        }
      ],
      "invoice_grouping_key": "<string>",
      "discount": {
        "discount_type": "percentage",
        "percentage_discount": 0.5,
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "filters": [
          {
            "values": [
              "<string>"
            ]
          }
        ],
        "reason": "<string>"
      },
      "minimum": {
        "minimum_amount": "<string>",
        "filters": [
          {
            "values": [
              "<string>"
            ]
          }
        ],
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "minimum_amount": "<string>",
      "maximum": {
        "maximum_amount": "<string>",
        "filters": [
          {
            "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>"
      }
    }
  ],
  "adjustments": [
    {
      "id": "<string>",
      "is_invoice_level": true,
      "filters": [
        {
          "values": [
            "<string>"
          ]
        }
      ],
      "applies_to_price_ids": [
        "<string>"
      ],
      "reason": "<string>",
      "replaces_adjustment_id": "<string>",
      "adjustment_type": "usage_discount",
      "usage_discount": 123,
      "plan_phase_order": 123
    }
  ]
}
{
"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

plan_id
string | null
required

Body

application/json
version
integer
required

New version number.

add_prices
AddPlanPriceParams · object[] | null

Additional prices to be added to the plan.

remove_prices
RemovePlanPriceParams · object[] | null

Prices to be removed from the plan.

replace_prices
ReplacePlanPriceParams · object[] | null

Prices to be replaced with additional prices on the plan.

add_adjustments
AddPlanAdjustmentParams · object[] | null

Additional adjustments to be added to the plan.

remove_adjustments
RemovePlanAdjustmentParams · object[] | null

Adjustments to be removed from the plan.

replace_adjustments
ReplacePlanAdjustmentParams · object[] | null

Adjustments to be replaced with additional adjustments on the plan.

set_as_default
boolean | null

Set this new plan version as the default

Response

Created

The PlanVersion resource represents the prices and adjustments present on a specific version of a plan.

created_at
string<date-time>
required
version
integer
required
plan_phases
PlanVersionPhase · object[] | null
required
prices
(UnitPrice · object | TieredPrice · object | BulkPrice · object | BulkWithFiltersPrice · object | PackagePrice · object | MatrixPrice · object | ThresholdTotalAmountPrice · object | TieredPackagePrice · object | TieredWithMinimumPrice · object | GroupedTieredPrice · object | TieredPackageWithMinimumPrice · object | PackageWithAllocationPrice · object | UnitWithPercentPrice · object | MatrixWithAllocationPrice · object | MatrixWithThresholdDiscountsPrice · object | TieredWithProrationPrice · object | UnitWithProrationPrice · object | GroupedAllocationPrice · object | BulkWithProrationPrice · object | GroupedWithProratedMinimumPrice · object | GroupedWithMeteredMinimumPrice · object | GroupedWithMinMaxThresholdsPrice · object | MatrixWithDisplayNamePrice · object | GroupedTieredPackagePrice · object | MaxGroupTieredPackagePrice · object | ScalableMatrixWithUnitPricingPrice · object | ScalableMatrixWithTieredPricingPrice · object | CumulativeGroupedBulkPrice · object | CumulativeGroupedAllocationPrice · object | DailyCreditAllowancePrice · object | MeteredAllowancePrice · object | MinimumCompositePrice · object | PercentCompositePrice · object | EventOutputPrice · object)[]
required

Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.

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

adjustments
(PlanPhaseUsageDiscountAdjustment · object | PlanPhaseAmountDiscountAdjustment · object | PlanPhasePercentageDiscountAdjustment · object | PlanPhaseTieredPercentageDiscountAdjustment · object | PlanPhaseMinimumAdjustment · object | PlanPhaseMaximumAdjustment · object)[]
required

Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan.