List plans
This endpoint returns a list of all plans for an account in a list format.
The list of plans is ordered starting from the most recently created plan.
The response also includes pagination_metadata,
which lets the caller retrieve the next page of results if they exist.
Authorizations
API Keys can be issued in the Orb's web application.
Query Parameters
The number of items to fetch. Defaults to 20.
1 < x < 1000Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
The plan status to filter to ('active', 'archived', or 'draft').
active, archived, draft Response
Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan.
amount_discount The amount by which to discount the prices this adjustment applies to in a given billing period.
The price IDs that this adjustment applies to.
True for adjustments that apply to an entire invocice, false for adjustments that apply to only one price.
The plan phase in which this adjustment is active.
The reason for the adjustment.
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.
The parent plan id if the given plan was created by overriding one or more of the parent's prices
An ISO 4217 currency string or custom pricing unit (credits) for this plan's prices.
The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo.
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
percentage Only available if discount_type is percentage. This is a number between 0 and 1.
0 < x < 1An 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.
An ISO 4217 currency string for which this plan is billed in. Matches currency unless currency is a custom pricing unit.
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.
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.
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
percentage Only available if discount_type is percentage. This is a number between 0 and 1.
0 < x < 1How many terms of length duration_unit this phase is active for. If null, this phase is evergreen and active indefinitely
daily, monthly, quarterly, semi_annual, annual Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.
one_time, monthly, quarterly, semi_annual, annual, custom List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
percentage Only available if discount_type is percentage. This is a number between 0 and 1.
0 < x < 1User 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.
unit usage_price, fixed_price active, archived, draft Was this page helpful?