Skip to main content
GET
/
prices
/
external_price_id
/
{external_price_id}
Fetch price by external price id
curl --request GET \
  --url https://api.withorb.com/v1/prices/external_price_id/{external_price_id} \
  --header 'Authorization: Bearer <token>'
{
  "model_type": "unit",
  "unit_config": {
    "unit_amount": "<string>",
    "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>"
  },
  "dimensional_price_configuration": {
    "dimensional_price_group_id": "<string>",
    "dimension_values": [
      "<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>"
        ]
      }
    ]
  },
  "composite_price_filters": [
    {
      "field": "price_id",
      "operator": "includes",
      "values": [
        "<any>"
      ]
    }
  ],
  "discount": {
    "discount_type": "percentage",
    "applies_to_price_ids": [
      "h74gfhdjvn7ujokd",
      "7hfgtgjnbvc3ujkl"
    ],
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<any>"
        ]
      }
    ],
    "reason": "<string>",
    "percentage_discount": 0.15
  },
  "minimum": {
    "minimum_amount": "<string>",
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<any>"
        ]
      }
    ],
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "minimum_amount": "<string>",
  "maximum": {
    "maximum_amount": "<string>",
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<any>"
        ]
      }
    ],
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "maximum_amount": "<string>"
}

Authorizations

Authorization
string
header
required

Path Parameters

external_price_id
string
required

Response

  • UnitPrice
  • TieredPrice
  • BulkPrice
  • BulkWithFiltersPrice
  • PackagePrice
  • MatrixPrice
  • ThresholdTotalAmountPrice
  • TieredPackagePrice
  • TieredWithMinimumPrice
  • GroupedTieredPrice
  • TieredPackageWithMinimumPrice
  • PackageWithAllocationPrice
  • UnitWithPercentPrice
  • MatrixWithAllocationPrice
  • TieredWithProrationPrice
  • UnitWithProrationPrice
  • GroupedAllocationPrice
  • BulkWithProrationPrice
  • GroupedWithProratedMinimumPrice
  • GroupedWithMeteredMinimumPrice
  • GroupedWithMinMaxThresholdsPrice
  • MatrixWithDisplayNamePrice
  • GroupedTieredPackagePrice
  • MaxGroupTieredPackagePrice
  • ScalableMatrixWithUnitPricingPrice
  • ScalableMatrixWithTieredPricingPrice
  • CumulativeGroupedBulkPrice
  • CumulativeGroupedAllocationPrice
  • MinimumCompositePrice
  • PercentCompositePrice
  • EventOutputPrice
model_type
enum<string>
required
Available options:
unit
unit_config
object
required
metadata
object
required
id
string
required
name
string
required
external_price_id
string | null
required
replaces_price_id
string | null
required
price_type
enum<string>
required
Available options:
usage_price,
fixed_price,
composite_price
created_at
string<date-time>
required
cadence
enum<string>
required
Available options:
one_time,
monthly,
quarterly,
semi_annual,
annual,
custom
billing_mode
enum<string>
required
Available options:
in_advance,
in_arrear
billing_cycle_configuration
object
required
invoicing_cycle_configuration
object | null
required
billable_metric
object | null
required
fixed_price_quantity
number | null
required
plan_phase_order
integer | null
required
currency
string
required
conversion_rate
number | null
required
conversion_rate_config
object | null
required
  • UnitConversionRateConfig
  • TieredConversionRateConfig
item
object
required
credit_allocation
object | null
required
composite_price_filters
PriceFilter · object[] | null
required
discount
object | null
required
deprecated
  • PercentageDiscount
  • TrialDiscount
  • UsageDiscount
  • AmountDiscount
minimum
object | null
required
deprecated
minimum_amount
string | null
required
deprecated
maximum
object | null
required
deprecated
maximum_amount
string | null
required
deprecated
dimensional_price_configuration
object | null