GET
/
plans
/
{plan_id}
curl --request GET \
  --url https://api.withorb.com/v1/plans/{plan_id} \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "maximum_amount": "<string>",
  "minimum_amount": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "status": "active",
  "maximum": {
    "maximum_amount": "<string>",
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "minimum": {
    "minimum_amount": "<string>",
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "discount": {
    "discount_type": "percentage",
    "applies_to_price_ids": [
      "h74gfhdjvn7ujokd",
      "7hfgtgjnbvc3ujkl"
    ],
    "reason": "<string>",
    "percentage_discount": 0.15
  },
  "product": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>"
  },
  "version": 123,
  "trial_config": {
    "trial_period": 123,
    "trial_period_unit": "days"
  },
  "plan_phases": [
    {
      "id": "<string>",
      "description": "<string>",
      "duration": 123,
      "duration_unit": "daily",
      "name": "<string>",
      "order": 123,
      "minimum": {
        "minimum_amount": "<string>",
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ]
      },
      "maximum": {
        "maximum_amount": "<string>",
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ]
      },
      "maximum_amount": "<string>",
      "minimum_amount": "<string>",
      "discount": {
        "discount_type": "percentage",
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "reason": "<string>",
        "percentage_discount": 0.15
      }
    }
  ],
  "base_plan": {
    "id": "m2t5akQeh2obwxeU",
    "external_plan_id": "m2t5akQeh2obwxeU",
    "name": "Example plan"
  },
  "base_plan_id": "<string>",
  "external_plan_id": "<string>",
  "currency": "<string>",
  "invoicing_currency": "<string>",
  "net_terms": 123,
  "default_invoice_memo": "<string>",
  "prices": [
    {
      "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
      },
      "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>"
            ]
          }
        ]
      },
      "minimum_amount": "<string>",
      "maximum": {
        "maximum_amount": "<string>",
        "filters": [
          {
            "field": "price_id",
            "operator": "includes",
            "values": [
              "<string>"
            ]
          }
        ]
      },
      "maximum_amount": "<string>",
      "unit_config": {
        "unit_amount": "<string>"
      }
    }
  ],
  "adjustments": [
    {
      "id": "<string>",
      "is_invoice_level": true,
      "filters": [
        {
          "field": "price_id",
          "operator": "includes",
          "values": [
            "<string>"
          ]
        }
      ],
      "reason": "<string>",
      "adjustment_type": "usage_discount",
      "usage_discount": 123,
      "plan_phase_order": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
plan_id
string
required

Response

200
application/json
OK

The Plan resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices in the Price resource.

​
metadata
object
required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

​
id
string
required
​
name
string
required
​
description
string
required
​
maximum_amount
string | null
required
​
minimum_amount
string | null
required
​
created_at
string
required
​
status
enum<string>
required
Available options:
active,
archived,
draft
​
maximum
object | null
required
​
minimum
object | null
required
​
discount
object | null
required
​
product
object
required
​
version
integer
required
​
trial_config
object
required
​
plan_phases
object[] | null
required
​
base_plan
object | null
required
​
base_plan_id
string | null
required

The parent plan id if the given plan was created by overriding one or more of the parent's prices

​
external_plan_id
string | null
required

An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.

​
currency
string
required
deprecated

An ISO 4217 currency string or custom pricing unit (credits) for this plan's prices.

​
invoicing_currency
string
required

An ISO 4217 currency string for which this plan is billed in. Matches currency unless currency is a custom pricing unit.

​
net_terms
integer | null
required

Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration.

​
default_invoice_memo
string | null
required

The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo.

​
prices
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
object[]
required

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