POST
/
prices
curl --request POST \
  --url https://api.withorb.com/v1/prices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {},
  "external_price_id": "<string>",
  "name": "Annual fee",
  "dimensional_price_configuration": {
    "dimensional_price_group_id": "<string>",
    "external_dimensional_price_group_id": "<string>",
    "dimension_values": [
      "<string>"
    ]
  },
  "billable_metric_id": "<string>",
  "item_id": "<string>",
  "billed_in_advance": true,
  "fixed_price_quantity": 123,
  "invoice_grouping_key": "<string>",
  "cadence": "annual",
  "billing_cycle_configuration": {
    "duration": 123,
    "duration_unit": "day"
  },
  "invoicing_cycle_configuration": {
    "duration": 123,
    "duration_unit": "day"
  },
  "conversion_rate": 123,
  "model_type": "unit",
  "unit_config": {
    "unit_amount": "<string>"
  },
  "currency": "<string>"
}'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "external_price_id": "<string>",
  "price_type": "usage_price",
  "model_type": "unit",
  "created_at": "2023-11-07T05:31:56Z",
  "cadence": "one_time",
  "billing_cycle_configuration": {
    "duration": 123,
    "duration_unit": "day"
  },
  "invoicing_cycle_configuration": {
    "duration": 123,
    "duration_unit": "day"
  },
  "billable_metric": {
    "id": "<string>"
  },
  "dimensional_price_configuration": {
    "dimensional_price_group_id": "<string>",
    "dimension_values": [
      "<string>"
    ]
  },
  "fixed_price_quantity": 123,
  "plan_phase_order": 123,
  "currency": "<string>",
  "conversion_rate": 123,
  "item": {
    "id": "<string>",
    "name": "<string>"
  },
  "credit_allocation": {
    "currency": "<string>",
    "allows_rollover": true,
    "custom_expiration": {
      "duration": 123,
      "duration_unit": "day"
    }
  },
  "discount": {
    "discount_type": "percentage",
    "applies_to_price_ids": [
      "h74gfhdjvn7ujokd",
      "7hfgtgjnbvc3ujkl"
    ],
    "reason": "<string>",
    "percentage_discount": 0.15
  },
  "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>",
  "unit_config": {
    "unit_amount": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Response

201
application/json

Created

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