v1

latestOpenAPI 3.1.02026-07-261444991.2 MB

Plan

Fetch plan by external ID

This endpoint is used to fetch plan details given an external_plan_id identifier. It returns information about the prices included in the plan and their configuration, as well as the product that the plan is attached to.

If multiple plans are found to contain the specified external_plan_id, the active plans will take priority over archived ones, and among those, the endpoint will return the most recently created plan.

Serialized prices

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. A detailed explanation of price types can be found in the Price schema. "

get/plans/external_plan_id/{external_plan_id}

Path parameters

external_plan_idstring required

Response

metadataobject 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.

idstring required

namestring required

descriptionstring required

maximum_amountstring nullable required

minimum_amountstring nullable required

created_atstring date-time required

status'active' | 'archived' | 'draft' required

versioninteger required

base_plan_idstring nullable required

Legacy field representing the parent plan ID if the current plan is a 'child plan', overriding prices from the parent.

external_plan_idstring nullable 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.

currencystring required

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

invoicing_currencystring required

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

net_termsinteger nullable 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_memostring nullable required

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