orb-billing 1.20.2 → 1.22.0

package/docs/sdks/plan/README.md

@@ -1,298 +0,0 @@
-# Plan
-(*plan*)
-
-## Overview
-
-The [Plan](../guides/core-concepts.mdx#plan-and-price) 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](/reference/price).
-
-### Available Operations
-
-* [create](#create) - Create plan
-* [fetch](#fetch) - Fetch plan
-* [fetchByExternalId](#fetchbyexternalid) - Fetch plan by external ID
-* [list](#list) - List plans
-* [updatePlan](#updateplan) - Update plan by id
-* [updatePlanExternal](#updateplanexternal) - Update plan by external ID
-
-## create
-
-This endpoint allows creation of plans including their prices.
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-
-  const res = await sdk.plan.create({
-    currency: "Lithuanian Litas",
-    metadata: {},
-    name: "Configuration Money",
-    prices: [
-      {},
-    ],
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `request`                                                    | [shared.NewPlan](../../models/shared/newplan.md)             | :heavy_check_mark:                                           | The request object to use for the request.                   |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.CreatePlanResponse](../../models/operations/createplanresponse.md)>**
-
-
-## fetch
-
-This endpoint is used to fetch [plan](../guides/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](../guides/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](../guides/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.
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { FetchPlanRequest } from "orb-billing/dist/sdk/models/operations";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-const planId: string = "grateful";
-
-  const res = await sdk.plan.fetch(planId);
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `planId`                                                     | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.FetchPlanResponse](../../models/operations/fetchplanresponse.md)>**
-
-
-## fetchByExternalId
-
-This endpoint is used to fetch [plan](../guides/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.
-
-## Serialized prices
-Orb supports a few different pricing models
-out of the box. Each of these models is serialized differently in a given [Price](../guides/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](../guides/concepts#plan-and-price). "
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { FetchPlanExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-const externalPlanId: string = "Technician";
-
-  const res = await sdk.plan.fetchByExternalId(externalPlanId);
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `externalPlanId`                                             | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.FetchPlanExternalIdResponse](../../models/operations/fetchplanexternalidresponse.md)>**
-
-
-## list
-
-This endpoint returns a list of all [plans](../guides/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`](../reference/pagination),
-which lets the caller retrieve the next page of results if they exist.
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { ListPlansStatusStatus } from "orb-billing/dist/sdk/models/operations";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-
-  const res = await sdk.plan.list({});
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                                  | Type                                                                       | Required                                                                   | Description                                                                |
-| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
-| `request`                                                                  | [operations.ListPlansRequest](../../models/operations/listplansrequest.md) | :heavy_check_mark:                                                         | The request object to use for the request.                                 |
-| `config`                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)               | :heavy_minus_sign:                                                         | Available config options for making requests.                              |
-
-
-### Response
-
-**Promise<[operations.ListPlansResponse](../../models/operations/listplansresponse.md)>**
-
-
-## updatePlan
-
-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.
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { UpdatePlanRequest } from "orb-billing/dist/sdk/models/operations";
-import { EditPlan, EditPlanMetadata } from "orb-billing/dist/sdk/models/shared";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-const planId: string = "hie";
-const editPlan: EditPlan = {
-  metadata: {},
-};
-
-  const res = await sdk.plan.updatePlan(planId, editPlan);
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `planId`                                                     | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
-| `editPlan`                                                   | [shared.EditPlan](../../models/shared/editplan.md)           | :heavy_minus_sign:                                           | N/A                                                          |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.UpdatePlanResponse](../../models/operations/updateplanresponse.md)>**
-
-
-## updatePlanExternal
-
-This endpoint is used to fetch [plan](../guides/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.
-
-## Serialized prices
-Orb supports a few different pricing models out of the box. Each of these
-models is serialized differently in a given [Price](../guides/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](../guides/concepts#plan-and-price).
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { UpdatePlanExternalRequest } from "orb-billing/dist/sdk/models/operations";
-import { EditPlan, EditPlanMetadata } from "orb-billing/dist/sdk/models/shared";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-const externalPlanId: string = "morph";
-const editPlan: EditPlan = {
-  metadata: {},
-};
-
-  const res = await sdk.plan.updatePlanExternal(externalPlanId, editPlan);
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `externalPlanId`                                             | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
-| `editPlan`                                                   | [shared.EditPlan](../../models/shared/editplan.md)           | :heavy_minus_sign:                                           | N/A                                                          |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.UpdatePlanExternalResponse](../../models/operations/updateplanexternalresponse.md)>**
-

package/docs/sdks/price/README.md

@@ -1,375 +0,0 @@
-# Price
-(*price*)
-
-## Overview
-
-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.
-
-## Unit pricing
-With unit pricing, each unit costs a fixed amount.
-```json
-{
-    ...
-    "model_type": "unit",
-    "unit_config": {
-        "unit_amount": "0.50"
-    }
-    ...
-}
-```
-
-## Tiered pricing
-In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is
-defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter
-may cost $0.10 each.
-```json
-{
-    ...
-    "model_type": "tiered",
-    "tiered_config": {
-        "tiers": [
-            {
-                "first_unit": 1,
-                "last_unit": 10,
-                "unit_amount": "0.50"
-            },
-            {
-                "first_unit": 11,
-                "last_unit": null,
-                "unit_amount": "0.10"
-            }
-        ]
-    }
-    ...
-```
-
-## Bulk pricing
-Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less
-than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may
-now be priced at $0.40 (i.e. 101 units total would be $40.40).
-```json
-{
-    ...
-    "model_type": "bulk",
-    "bulk_config": {
-        "tiers": [
-            {
-                "maximum_units": 10,
-                "unit_amount": "0.50"
-            },
-            {
-                "maximum_units": 1000,
-                "unit_amount": "0.40"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Package pricing
-Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is
-set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
-```json
-{
-    ...
-    "model_type": "package",
-    "package_config": {
-        "package_amount": "0.80",
-        "package_size": 10
-    }
-    ...
-}
-```
-
-## BPS pricing
-BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points
-to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on
-every payment you process, with a maximum charge of $25 per payment.
-```json
-{
-    ...
-    "model_type": "bps",
-    "bps_config": {
-       "bps": 125,
-       "per_unit_maximum": "11.00"
-    }
-    ...
- }
-```
-
-## Bulk BPS pricing
-Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events.
-Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period
-falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached,
-each individual payment may have a lower cap or a smaller take-rate.
-```json
-    ...
-    "model_type": "bulk_bps",
-    "bulk_bps_config": {
-        "tiers": [
-           {
-                "maximum_amount": "1000000.00",
-                "bps": 125,
-                "per_unit_maximum": "19.00"
-           },
-          {
-                "maximum_amount": null,
-                "bps": 115,
-                "per_unit_maximum": "4.00"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Tiered BPS pricing
-Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a
-function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given
-event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound.
-For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may
-incur a take-rate of 0.5 BPS each.
-```json
-    ...
-    "model_type": "tiered_bps",
-    "tiered_bps_config": {
-        "tiers": [
-           {
-                "minimum_amount": "0",
-                "maximum_amount": "1000000.00",
-                "bps": 125,
-                "per_unit_maximum": "19.00"
-           },
-          {
-                "minimum_amount": "1000000.00",
-                "maximum_amount": null,
-                "bps": 115,
-                "per_unit_maximum": "4.00"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Matrix pricing
-Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. `dimensions` defines the two event
-property values evaluated in this pricing model. In a one-dimensional matrix, the second value is `null`. Every
-configuration has a list of `matrix_values` which give the unit prices for specified property values. In a
-one-dimensional matrix, the matrix values will have `dimension_values` where the second value of the pair is null.
-If an event does not match any of the dimension values in the matrix, it will resort to the `default_unit_amount`.
-```json
-{
-    "model_type": "matrix"
-    "matrix_config": {
-        "default_unit_amount": "3.00",
-        "dimensions": [
-            "cluster_name",
-            "region"
-        ],
-        "matrix_values": [
-            {
-                "dimension_values": [
-                    "alpha",
-                    "west"
-                ],
-                "unit_amount": "2.00"
-            },
-            ...
-        ]
-    }
-}
-```
-
-### Fixed fees
-Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an
-additional parameter `fixed_price_quantity`. If the Price represents a fixed cost, this represents the quantity of
-units applied.
-```json
-{
-    ...
-    "id": "price_id",
-    "model_type": "unit",
-    "unit_config": {
-       "unit_amount": "2.00"
-    },
-    "fixed_price_quantity": 3.0
-    ...
-}
-```
-
-### Available Operations
-
-* [create](#create) - Create price
-* [fetch](#fetch) - Fetch price
-* [fetchByExternalId](#fetchbyexternalid) - Fetch price by external price id
-* [list](#list) - List prices
-
-## create
-
-This endpoint is used to create a [price](../reference/price).
-A price created using this endpoint is always an add-on, meaning that it’s not associated with a specific plan and can instead
-be individually added to subscriptions, including subscriptions on different plans.
-
-An `external_price_id` can be optionally specified as an alias to allow ergonomic interaction with prices in the Orb API.
-
-See the [Price resource](../reference/price) for the specification of
-different price model configurations possible in this endpoint.
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-
-  const res = await sdk.price.create("online");
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `request`                                                    | [any](../../models//.md)                                     | :heavy_check_mark:                                           | The request object to use for the request.                   |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.CreatePriceResponse](../../models/operations/createpriceresponse.md)>**
-
-
-## fetch
-
-This endpoint returns a price given an identifier.
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { FetchPriceRequest } from "orb-billing/dist/sdk/models/operations";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-const priceId: string = "grateful";
-
-  const res = await sdk.price.fetch(priceId);
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `priceId`                                                    | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.FetchPriceResponse](../../models/operations/fetchpriceresponse.md)>**
-
-
-## fetchByExternalId
-
-This endpoint returns a price given an external price id.
-See the [price creation API](../reference/create-price) for more information about external price aliases.
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { FetchPriceExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-const externalPriceId: string = "Technician";
-
-  const res = await sdk.price.fetchByExternalId(externalPriceId);
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `externalPriceId`                                            | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.FetchPriceExternalIdResponse](../../models/operations/fetchpriceexternalidresponse.md)>**
-
-
-## list
-
-This endpoint is used to list all add-on prices created using the [price creation endpoint](../reference/create-price).
-
-### Example Usage
-
-```typescript
-import { Orb } from "orb-billing";
-import { ListPricesRequest } from "orb-billing/dist/sdk/models/operations";
-
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
-const cursor: string = "Bicycle";
-const limit: number = 257649;
-
-  const res = await sdk.price.list(cursor, limit);
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-
-### Parameters
-
-| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `cursor`                                                     | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
-| `limit`                                                      | *number*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
-| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
-
-
-### Response
-
-**Promise<[operations.ListPricesResponse](../../models/operations/listpricesresponse.md)>**
-