PUT
/
plans
/
{plan_id}
curl --request PUT \
  --url https://api.withorb.com/v1/plans/{plan_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {},
  "external_plan_id": "<string>"
}'
{
  "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

Body

application/json

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.