orb-billing 0.1.0.pre.alpha.33

data/lib/orb/resources/invoices.rb

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Invoices
+      # This endpoint is used to create a one-off invoice for a customer.
+      #
+      # @overload create(currency:, invoice_date:, line_items:, net_terms:, customer_id: nil, discount: nil, external_customer_id: nil, memo: nil, metadata: nil, will_auto_issue: nil, request_options: {})
+      #
+      # @param currency [String]
+      # @param invoice_date [Time]
+      # @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
+      # @param net_terms [Integer]
+      # @param customer_id [String, nil]
+      # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+      # @param external_customer_id [String, nil]
+      # @param memo [String, nil]
+      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      # @param will_auto_issue [Boolean]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Invoice]
+      #
+      # @see Orb::Models::InvoiceCreateParams
+      def create(params)
+        parsed, options = Orb::Models::InvoiceCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "invoices",
+          body: parsed,
+          model: Orb::Models::Invoice,
+          options: options
+        )
+      end
+
+      # This endpoint allows you to update the `metadata` property on an invoice. If you
+      #   pass null for the metadata value, it will clear any existing metadata for that
+      #   invoice.
+      #
+      #   `metadata` can be modified regardless of invoice state.
+      #
+      # @overload update(invoice_id, metadata: nil, request_options: {})
+      #
+      # @param invoice_id [String]
+      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Invoice]
+      #
+      # @see Orb::Models::InvoiceUpdateParams
+      def update(invoice_id, params = {})
+        parsed, options = Orb::Models::InvoiceUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["invoices/%1$s", invoice_id],
+          body: parsed,
+          model: Orb::Models::Invoice,
+          options: options
+        )
+      end
+
+      # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an
+      #   account in a list format.
+      #
+      #   The list of invoices is ordered starting from the most recently issued invoice
+      #   date. The response also includes
+      #   [`pagination_metadata`](/api-reference/pagination), which lets the caller
+      #   retrieve the next page of results if they exist.
+      #
+      #   By default, this only returns invoices that are `issued`, `paid`, or `synced`.
+      #
+      #   When fetching any `draft` invoices, this returns the last-computed invoice
+      #   values for each draft invoice, which may not always be up-to-date since Orb
+      #   regularly refreshes invoices asynchronously.
+      #
+      # @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
+      #
+      # @param amount [String, nil]
+      # @param amount_gt [String, nil]
+      # @param amount_lt [String, nil]
+      # @param cursor [String, nil]
+      # @param customer_id [String, nil]
+      # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
+      # @param due_date [Date, nil]
+      # @param due_date_window [String, nil]
+      # @param due_date_gt [Date, nil]
+      # @param due_date_lt [Date, nil]
+      # @param external_customer_id [String, nil]
+      # @param invoice_date_gt [Time, nil]
+      # @param invoice_date_gte [Time, nil]
+      # @param invoice_date_lt [Time, nil]
+      # @param invoice_date_lte [Time, nil]
+      # @param is_recurring [Boolean, nil]
+      # @param limit [Integer]
+      # @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
+      # @param subscription_id [String, nil]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Page<Orb::Models::Invoice>]
+      #
+      # @see Orb::Models::InvoiceListParams
+      def list(params = {})
+        parsed, options = Orb::Models::InvoiceListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "invoices",
+          query: parsed,
+          page: Orb::Page,
+          model: Orb::Models::Invoice,
+          options: options
+        )
+      end
+
+      # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
+      #   identifier.
+      #
+      # @overload fetch(invoice_id, request_options: {})
+      #
+      # @param invoice_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Invoice]
+      #
+      # @see Orb::Models::InvoiceFetchParams
+      def fetch(invoice_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["invoices/%1$s", invoice_id],
+          model: Orb::Models::Invoice,
+          options: params[:request_options]
+        )
+      end
+
+      # This endpoint can be used to fetch the upcoming
+      #   [invoice](/core-concepts#invoice) for the current billing period given a
+      #   subscription.
+      #
+      # @overload fetch_upcoming(subscription_id:, request_options: {})
+      #
+      # @param subscription_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::InvoiceFetchUpcomingResponse]
+      #
+      # @see Orb::Models::InvoiceFetchUpcomingParams
+      def fetch_upcoming(params)
+        parsed, options = Orb::Models::InvoiceFetchUpcomingParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "invoices/upcoming",
+          query: parsed,
+          model: Orb::Models::InvoiceFetchUpcomingResponse,
+          options: options
+        )
+      end
+
+      # This endpoint allows an eligible invoice to be issued manually. This is only
+      #   possible with invoices where status is `draft`, `will_auto_issue` is false, and
+      #   an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
+      #   possibly trigger side effects, some of which could be customer-visible (e.g.
+      #   sending emails, auto-collecting payment, syncing the invoice to external
+      #   providers, etc).
+      #
+      # @overload issue(invoice_id, synchronous: nil, request_options: {})
+      #
+      # @param invoice_id [String]
+      # @param synchronous [Boolean]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Invoice]
+      #
+      # @see Orb::Models::InvoiceIssueParams
+      def issue(invoice_id, params = {})
+        parsed, options = Orb::Models::InvoiceIssueParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["invoices/%1$s/issue", invoice_id],
+          body: parsed,
+          model: Orb::Models::Invoice,
+          options: options
+        )
+      end
+
+      # This endpoint allows an invoice's status to be set the `paid` status. This can
+      #   only be done to invoices that are in the `issued` status.
+      #
+      # @overload mark_paid(invoice_id, payment_received_date:, external_id: nil, notes: nil, request_options: {})
+      #
+      # @param invoice_id [String]
+      # @param payment_received_date [Date]
+      # @param external_id [String, nil]
+      # @param notes [String, nil]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Invoice]
+      #
+      # @see Orb::Models::InvoiceMarkPaidParams
+      def mark_paid(invoice_id, params)
+        parsed, options = Orb::Models::InvoiceMarkPaidParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["invoices/%1$s/mark_paid", invoice_id],
+          body: parsed,
+          model: Orb::Models::Invoice,
+          options: options
+        )
+      end
+
+      # This endpoint collects payment for an invoice using the customer's default
+      #   payment method. This action can only be taken on invoices with status "issued".
+      #
+      # @overload pay(invoice_id, request_options: {})
+      #
+      # @param invoice_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Invoice]
+      #
+      # @see Orb::Models::InvoicePayParams
+      def pay(invoice_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["invoices/%1$s/pay", invoice_id],
+          model: Orb::Models::Invoice,
+          options: params[:request_options]
+        )
+      end
+
+      # This endpoint allows an invoice's status to be set the `void` status. This can
+      #   only be done to invoices that are in the `issued` status.
+      #
+      #   If the associated invoice has used the customer balance to change the amount
+      #   due, the customer balance operation will be reverted. For example, if the
+      #   invoice used $10 of customer balance, that amount will be added back to the
+      #   customer balance upon voiding.
+      #
+      #   If the invoice was used to purchase a credit block, but the invoice is not yet
+      #   paid, the credit block will be voided. If the invoice was created due to a
+      #   top-up, the top-up will be disabled.
+      #
+      # @overload void(invoice_id, request_options: {})
+      #
+      # @param invoice_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Invoice]
+      #
+      # @see Orb::Models::InvoiceVoidParams
+      def void(invoice_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["invoices/%1$s/void", invoice_id],
+          model: Orb::Models::Invoice,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Orb::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/orb/resources/items.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Items
+      # This endpoint is used to create an [Item](/core-concepts#item).
+      #
+      # @overload create(name:, request_options: {})
+      #
+      # @param name [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Item]
+      #
+      # @see Orb::Models::ItemCreateParams
+      def create(params)
+        parsed, options = Orb::Models::ItemCreateParams.dump_request(params)
+        @client.request(method: :post, path: "items", body: parsed, model: Orb::Models::Item, options: options)
+      end
+
+      # This endpoint can be used to update properties on the Item.
+      #
+      # @overload update(item_id, external_connections: nil, name: nil, request_options: {})
+      #
+      # @param item_id [String]
+      # @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
+      # @param name [String, nil]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Item]
+      #
+      # @see Orb::Models::ItemUpdateParams
+      def update(item_id, params = {})
+        parsed, options = Orb::Models::ItemUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["items/%1$s", item_id],
+          body: parsed,
+          model: Orb::Models::Item,
+          options: options
+        )
+      end
+
+      # This endpoint returns a list of all Items, ordered in descending order by
+      #   creation time.
+      #
+      # @overload list(cursor: nil, limit: nil, request_options: {})
+      #
+      # @param cursor [String, nil]
+      # @param limit [Integer]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Page<Orb::Models::Item>]
+      #
+      # @see Orb::Models::ItemListParams
+      def list(params = {})
+        parsed, options = Orb::Models::ItemListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "items",
+          query: parsed,
+          page: Orb::Page,
+          model: Orb::Models::Item,
+          options: options
+        )
+      end
+
+      # This endpoint returns an item identified by its item_id.
+      #
+      # @overload fetch(item_id, request_options: {})
+      #
+      # @param item_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Item]
+      #
+      # @see Orb::Models::ItemFetchParams
+      def fetch(item_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["items/%1$s", item_id],
+          model: Orb::Models::Item,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Orb::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/orb/resources/metrics.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Metrics
+      # This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
+      #   string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
+      #   description of constructing SQL queries with examples.
+      #
+      # @overload create(description:, item_id:, name:, sql:, metadata: nil, request_options: {})
+      #
+      # @param description [String, nil]
+      # @param item_id [String]
+      # @param name [String]
+      # @param sql [String]
+      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::BillableMetric]
+      #
+      # @see Orb::Models::MetricCreateParams
+      def create(params)
+        parsed, options = Orb::Models::MetricCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "metrics",
+          body: parsed,
+          model: Orb::Models::BillableMetric,
+          options: options
+        )
+      end
+
+      # This endpoint allows you to update the `metadata` property on a metric. If you
+      #   pass `null` for the metadata value, it will clear any existing metadata for that
+      #   invoice.
+      #
+      # @overload update(metric_id, metadata: nil, request_options: {})
+      #
+      # @param metric_id [String]
+      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::BillableMetric]
+      #
+      # @see Orb::Models::MetricUpdateParams
+      def update(metric_id, params = {})
+        parsed, options = Orb::Models::MetricUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["metrics/%1$s", metric_id],
+          body: parsed,
+          model: Orb::Models::BillableMetric,
+          options: options
+        )
+      end
+
+      # This endpoint is used to fetch [metric](/core-concepts##metric) details given a
+      #   metric identifier. It returns information about the metrics including its name,
+      #   description, and item.
+      #
+      # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param created_at_gt [Time, nil]
+      # @param created_at_gte [Time, nil]
+      # @param created_at_lt [Time, nil]
+      # @param created_at_lte [Time, nil]
+      # @param cursor [String, nil]
+      # @param limit [Integer]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Page<Orb::Models::BillableMetric>]
+      #
+      # @see Orb::Models::MetricListParams
+      def list(params = {})
+        parsed, options = Orb::Models::MetricListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "metrics",
+          query: parsed,
+          page: Orb::Page,
+          model: Orb::Models::BillableMetric,
+          options: options
+        )
+      end
+
+      # This endpoint is used to list [metrics](/core-concepts#metric). It returns
+      #   information about the metrics including its name, description, and item.
+      #
+      # @overload fetch(metric_id, request_options: {})
+      #
+      # @param metric_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::BillableMetric]
+      #
+      # @see Orb::Models::MetricFetchParams
+      def fetch(metric_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["metrics/%1$s", metric_id],
+          model: Orb::Models::BillableMetric,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Orb::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/orb/resources/plans/external_plan_id.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Plans
+      class ExternalPlanID
+        # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
+        #   existing plan.
+        #
+        #   Other fields on a customer are currently immutable.
+        #
+        # @overload update(other_external_plan_id, external_plan_id: nil, metadata: nil, request_options: {})
+        #
+        # @param other_external_plan_id [String]
+        # @param external_plan_id [String, nil]
+        # @param metadata [Hash{Symbol=>String, nil}, nil]
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Plan]
+        #
+        # @see Orb::Models::Plans::ExternalPlanIDUpdateParams
+        def update(other_external_plan_id, params = {})
+          parsed, options = Orb::Models::Plans::ExternalPlanIDUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["plans/external_plan_id/%1$s", other_external_plan_id],
+            body: parsed,
+            model: Orb::Models::Plan,
+            options: options
+          )
+        end
+
+        # This endpoint is used to fetch [plan](/core-concepts##plan-and-price) 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](/core-concepts#plan-and-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](/core-concepts#plan-and-price). "
+        #
+        # @overload fetch(external_plan_id, request_options: {})
+        #
+        # @param external_plan_id [String]
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Plan]
+        #
+        # @see Orb::Models::Plans::ExternalPlanIDFetchParams
+        def fetch(external_plan_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["plans/external_plan_id/%1$s", external_plan_id],
+            model: Orb::Models::Plan,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Orb::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/orb/resources/plans.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Plans
+      # @return [Orb::Resources::Plans::ExternalPlanID]
+      attr_reader :external_plan_id
+
+      # This endpoint allows creation of plans including their prices.
+      #
+      # @overload create(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
+      #
+      # @param currency [String]
+      # @param name [String]
+      # @param prices [Array<Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice>]
+      # @param default_invoice_memo [String, nil]
+      # @param external_plan_id [String, nil]
+      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      # @param net_terms [Integer, nil]
+      # @param status [Symbol, Orb::Models::PlanCreateParams::Status]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Plan]
+      #
+      # @see Orb::Models::PlanCreateParams
+      def create(params)
+        parsed, options = Orb::Models::PlanCreateParams.dump_request(params)
+        @client.request(method: :post, path: "plans", body: parsed, model: Orb::Models::Plan, options: options)
+      end
+
+      # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
+      #   existing plan.
+      #
+      #   Other fields on a customer are currently immutable.
+      #
+      # @overload update(plan_id, external_plan_id: nil, metadata: nil, request_options: {})
+      #
+      # @param plan_id [String]
+      # @param external_plan_id [String, nil]
+      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Plan]
+      #
+      # @see Orb::Models::PlanUpdateParams
+      def update(plan_id, params = {})
+        parsed, options = Orb::Models::PlanUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["plans/%1$s", plan_id],
+          body: parsed,
+          model: Orb::Models::Plan,
+          options: options
+        )
+      end
+
+      # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) 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`](/api-reference/pagination), which lets the caller
+      #   retrieve the next page of results if they exist.
+      #
+      # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param created_at_gt [Time, nil]
+      # @param created_at_gte [Time, nil]
+      # @param created_at_lt [Time, nil]
+      # @param created_at_lte [Time, nil]
+      # @param cursor [String, nil]
+      # @param limit [Integer]
+      # @param status [Symbol, Orb::Models::PlanListParams::Status]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Page<Orb::Models::Plan>]
+      #
+      # @see Orb::Models::PlanListParams
+      def list(params = {})
+        parsed, options = Orb::Models::PlanListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "plans",
+          query: parsed,
+          page: Orb::Page,
+          model: Orb::Models::Plan,
+          options: options
+        )
+      end
+
+      # This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details
+      #   given a plan 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.
+      #
+      #   ## Serialized prices
+      #
+      #   Orb supports a few different pricing models out of the box. Each of these models
+      #   is serialized differently in a given [Price](/core-concepts#plan-and-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](/core-concepts#plan-and-price).
+      #
+      #   ## Phases
+      #
+      #   Orb supports plan phases, also known as contract ramps. For plans with phases,
+      #   the serialized prices refer to all prices across all phases.
+      #
+      # @overload fetch(plan_id, request_options: {})
+      #
+      # @param plan_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Plan]
+      #
+      # @see Orb::Models::PlanFetchParams
+      def fetch(plan_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["plans/%1$s", plan_id],
+          model: Orb::Models::Plan,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Orb::Client]
+      def initialize(client:)
+        @client = client
+        @external_plan_id = Orb::Resources::Plans::ExternalPlanID.new(client: client)
+      end
+    end
+  end
+end