orb-billing
Version:
The official TypeScript library for the Orb API
98 lines • 4.21 kB
JavaScript
;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.PlansPage = exports.Plans = void 0;
const resource_1 = require("../../resource.js");
const core_1 = require("../../core.js");
const ExternalPlanIDAPI = __importStar(require("./external-plan-id.js"));
const external_plan_id_1 = require("./external-plan-id.js");
const MigrationsAPI = __importStar(require("./migrations.js"));
const migrations_1 = require("./migrations.js");
const pagination_1 = require("../../pagination.js");
/**
* The [Plan](/core-concepts#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).
*/
class Plans extends resource_1.APIResource {
constructor() {
super(...arguments);
this.externalPlanId = new ExternalPlanIDAPI.ExternalPlanID(this._client);
this.migrations = new MigrationsAPI.Migrations(this._client);
}
/**
* This endpoint allows creation of plans including their prices.
*/
create(body, options) {
return this._client.post('/plans', { body, ...options });
}
/**
* This endpoint can be used to update the `external_plan_id`, and `metadata` of an
* existing plan.
*
* Other fields on a plan are currently immutable.
*/
update(planId, body, options) {
return this._client.put(`/plans/${planId}`, { body, ...options });
}
list(query = {}, options) {
if ((0, core_1.isRequestOptions)(query)) {
return this.list({}, query);
}
return this._client.getAPIList('/plans', PlansPage, { query, ...options });
}
/**
* 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.
*/
fetch(planId, options) {
return this._client.get(`/plans/${planId}`, options);
}
}
exports.Plans = Plans;
class PlansPage extends pagination_1.Page {
}
exports.PlansPage = PlansPage;
Plans.PlansPage = PlansPage;
Plans.ExternalPlanID = external_plan_id_1.ExternalPlanID;
Plans.Migrations = migrations_1.Migrations;
Plans.MigrationListResponsesPage = migrations_1.MigrationListResponsesPage;
//# sourceMappingURL=plans.js.map