orb-billing
Version:
The official TypeScript library for the Orb API
38 lines • 1.72 kB
JavaScript
;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
Object.defineProperty(exports, "__esModule", { value: true });
exports.ExternalPlanID = void 0;
const resource_1 = require("../../core/resource.js");
const path_1 = require("../../internal/utils/path.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 ExternalPlanID extends resource_1.APIResource {
/**
* This endpoint allows the creation of a new plan version for an existing plan.
*/
createPlanVersion(externalPlanID, body, options) {
return this._client.post((0, path_1.path) `/plans/external_plan_id/${externalPlanID}/versions`, { body, ...options });
}
/**
* This endpoint is used to fetch a plan version. It returns the phases, prices,
* and adjustments present on this version of the plan.
*/
fetchPlanVersion(version, params, options) {
const { external_plan_id } = params;
return this._client.get((0, path_1.path) `/plans/external_plan_id/${external_plan_id}/versions/${version}`, options);
}
/**
* This endpoint allows setting the default version of a plan.
*/
setDefaultPlanVersion(externalPlanID, body, options) {
return this._client.post((0, path_1.path) `/plans/external_plan_id/${externalPlanID}/set_default_version`, {
body,
...options,
});
}
}
exports.ExternalPlanID = ExternalPlanID;
//# sourceMappingURL=external-plan-id.js.map