@stigg/typescript 0.1.0-beta.10 → 0.1.0-beta.13

package/resources/v1/plans/entitlements.js

@@ -7,12 +7,29 @@ const path_1 = require("../../../internal/utils/path.js");
 class Entitlements extends resource_1.APIResource {
     /**
      * Creates one or more entitlements (feature or credit) on a draft plan.
+     *
+     * @example
+     * ```ts
+     * const entitlement =
+     *   await client.v1.plans.entitlements.create('planId', {
+     *     entitlements: [{ id: 'id', type: 'FEATURE' }],
+     *   });
+     * ```
      */
     create(planID, body, options) {
         return this._client.post((0, path_1.path) `/api/v1/plans/${planID}/entitlements`, { body, ...options });
     }
     /**
      * Updates an existing entitlement on a draft plan.
+     *
+     * @example
+     * ```ts
+     * const planEntitlement =
+     *   await client.v1.plans.entitlements.update('id', {
+     *     planId: 'planId',
+     *     type: 'FEATURE',
+     *   });
+     * ```
      */
     update(id, params, options) {
         const { planId, ...body } = params;
@@ -20,12 +37,26 @@ class Entitlements extends resource_1.APIResource {
     }
     /**
      * Retrieves a list of entitlements for a plan.
+     *
+     * @example
+     * ```ts
+     * const entitlements =
+     *   await client.v1.plans.entitlements.list('planId');
+     * ```
      */
     list(planID, options) {
         return this._client.get((0, path_1.path) `/api/v1/plans/${planID}/entitlements`, options);
     }
     /**
      * Deletes an entitlement from a draft plan.
+     *
+     * @example
+     * ```ts
+     * const planEntitlement =
+     *   await client.v1.plans.entitlements.delete('id', {
+     *     planId: 'planId',
+     *   });
+     * ```
      */
     delete(id, params, options) {
         const { planId } = params;

package/resources/v1/plans/entitlements.js.map

@@ -1 +1 @@
-{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1/plans/entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAc,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,eAAe,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACF;AAlCD,oCAkCC"}
+{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1/plans/entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CACJ,MAAc,EACd,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAc,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,eAAe,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACF;AAjED,oCAiEC"}

package/resources/v1/plans/entitlements.mjs

@@ -4,12 +4,29 @@ import { path } from "../../../internal/utils/path.mjs";
 export class Entitlements extends APIResource {
     /**
      * Creates one or more entitlements (feature or credit) on a draft plan.
+     *
+     * @example
+     * ```ts
+     * const entitlement =
+     *   await client.v1.plans.entitlements.create('planId', {
+     *     entitlements: [{ id: 'id', type: 'FEATURE' }],
+     *   });
+     * ```
      */
     create(planID, body, options) {
         return this._client.post(path `/api/v1/plans/${planID}/entitlements`, { body, ...options });
     }
     /**
      * Updates an existing entitlement on a draft plan.
+     *
+     * @example
+     * ```ts
+     * const planEntitlement =
+     *   await client.v1.plans.entitlements.update('id', {
+     *     planId: 'planId',
+     *     type: 'FEATURE',
+     *   });
+     * ```
      */
     update(id, params, options) {
         const { planId, ...body } = params;
@@ -17,12 +34,26 @@ export class Entitlements extends APIResource {
     }
     /**
      * Retrieves a list of entitlements for a plan.
+     *
+     * @example
+     * ```ts
+     * const entitlements =
+     *   await client.v1.plans.entitlements.list('planId');
+     * ```
      */
     list(planID, options) {
         return this._client.get(path `/api/v1/plans/${planID}/entitlements`, options);
     }
     /**
      * Deletes an entitlement from a draft plan.
+     *
+     * @example
+     * ```ts
+     * const planEntitlement =
+     *   await client.v1.plans.entitlements.delete('id', {
+     *     planId: 'planId',
+     *   });
+     * ```
      */
     delete(id, params, options) {
         const { planId } = params;

package/resources/v1/plans/entitlements.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"entitlements.mjs","sourceRoot":"","sources":["../../../src/resources/v1/plans/entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,MAAM,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAc,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,MAAM,eAAe,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACF"}
+{"version":3,"file":"entitlements.mjs","sourceRoot":"","sources":["../../../src/resources/v1/plans/entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CACJ,MAAc,EACd,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,MAAM,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAc,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,MAAM,eAAe,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,MAAM,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACF"}

package/resources/v1/plans/index.d.mts

@@ -1,3 +1,3 @@
 export { Entitlements, type PlanEntitlement, type EntitlementCreateResponse, type EntitlementListResponse, type EntitlementCreateParams, type EntitlementUpdateParams, type EntitlementDeleteParams, } from "./entitlements.mjs";
-export { Plans, type Plan, type PlanListResponse, type PlanPublishResponse, type PlanRemoveDraftResponse, type PlanCreateParams, type PlanUpdateParams, type PlanListParams, type PlanListChargesParams, type PlanListOverageChargesParams, type PlanPublishParams, type PlanListResponsesMyCursorIDPage, } from "./plans.mjs";
+export { Plans, type Plan, type PlanListResponse, type PlanListChargesResponse, type PlanListOverageChargesResponse, type PlanPublishResponse, type PlanRemoveDraftResponse, type PlanCreateParams, type PlanUpdateParams, type PlanListParams, type PlanListChargesParams, type PlanListOverageChargesParams, type PlanPublishParams, type PlanListResponsesMyCursorIDPage, type PlanListChargesResponsesMyCursorIDPage, type PlanListOverageChargesResponsesMyCursorIDPage, } from "./plans.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/v1/plans/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,GAC7B,2BAAuB;AACxB,OAAO,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC,oBAAgB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,GAC7B,2BAAuB;AACxB,OAAO,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,EACpC,KAAK,sCAAsC,EAC3C,KAAK,6CAA6C,GACnD,oBAAgB"}

package/resources/v1/plans/index.d.ts

@@ -1,3 +1,3 @@
 export { Entitlements, type PlanEntitlement, type EntitlementCreateResponse, type EntitlementListResponse, type EntitlementCreateParams, type EntitlementUpdateParams, type EntitlementDeleteParams, } from "./entitlements.js";
-export { Plans, type Plan, type PlanListResponse, type PlanPublishResponse, type PlanRemoveDraftResponse, type PlanCreateParams, type PlanUpdateParams, type PlanListParams, type PlanListChargesParams, type PlanListOverageChargesParams, type PlanPublishParams, type PlanListResponsesMyCursorIDPage, } from "./plans.js";
+export { Plans, type Plan, type PlanListResponse, type PlanListChargesResponse, type PlanListOverageChargesResponse, type PlanPublishResponse, type PlanRemoveDraftResponse, type PlanCreateParams, type PlanUpdateParams, type PlanListParams, type PlanListChargesParams, type PlanListOverageChargesParams, type PlanPublishParams, type PlanListResponsesMyCursorIDPage, type PlanListChargesResponsesMyCursorIDPage, type PlanListOverageChargesResponsesMyCursorIDPage, } from "./plans.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/v1/plans/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,GAC7B,0BAAuB;AACxB,OAAO,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC,mBAAgB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,GAC7B,0BAAuB;AACxB,OAAO,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,EACpC,KAAK,sCAAsC,EAC3C,KAAK,6CAA6C,GACnD,mBAAgB"}

package/resources/v1/plans/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAQwB;AAPtB,4GAAA,YAAY,OAAA;AAQd,oCAaiB;AAZf,8FAAA,KAAK,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAQwB;AAPtB,4GAAA,YAAY,OAAA;AAQd,oCAiBiB;AAhBf,8FAAA,KAAK,OAAA"}

package/resources/v1/plans/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,YAAY,GAOb,2BAAuB;AACxB,OAAO,EACL,KAAK,GAYN,oBAAgB"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/plans/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,YAAY,GAOb,2BAAuB;AACxB,OAAO,EACL,KAAK,GAgBN,oBAAgB"}

package/resources/v1/plans/plans.d.mts

@@ -1,6 +1,4 @@
 import { APIResource } from "../../../core/resource.mjs";
-import * as AddonsAPI from "../addons/addons.mjs";
-import { ChargeListDataMyCursorIDPage } from "../addons/addons.mjs";
 import * as EntitlementsAPI from "./entitlements.mjs";
 import { EntitlementCreateParams, EntitlementCreateResponse, EntitlementDeleteParams, EntitlementListResponse, EntitlementUpdateParams, Entitlements, PlanEntitlement } from "./entitlements.mjs";
 import { APIPromise } from "../../../core/api-promise.mjs";
@@ -13,48 +11,119 @@ export declare class Plans extends APIResource {
     entitlements: EntitlementsAPI.Entitlements;
     /**
      * Creates a new plan in draft status.
+     *
+     * @example
+     * ```ts
+     * const plan = await client.v1.plans.create({
+     *   id: 'id',
+     *   displayName: 'displayName',
+     *   productId: 'productId',
+     * });
+     * ```
      */
     create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Plan>;
     /**
      * Retrieves a plan by its unique identifier, including entitlements and pricing
      * details.
+     *
+     * @example
+     * ```ts
+     * const plan = await client.v1.plans.retrieve('x');
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Plan>;
     /**
      * Updates an existing plan's properties such as display name, description, and
      * metadata.
+     *
+     * @example
+     * ```ts
+     * const plan = await client.v1.plans.update('x');
+     * ```
      */
     update(id: string, body: PlanUpdateParams, options?: RequestOptions): APIPromise<Plan>;
     /**
      * Retrieves a paginated list of plans in the environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListResponse of client.v1.plans.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: PlanListParams | null | undefined, options?: RequestOptions): PagePromise<PlanListResponsesMyCursorIDPage, PlanListResponse>;
     /**
      * Archives a plan, preventing it from being used in new subscriptions.
+     *
+     * @example
+     * ```ts
+     * const plan = await client.v1.plans.archive('x');
+     * ```
      */
     archive(id: string, options?: RequestOptions): APIPromise<Plan>;
     /**
      * Creates a draft version of an existing plan for modification before publishing.
+     *
+     * @example
+     * ```ts
+     * const plan = await client.v1.plans.createDraft('x');
+     * ```
      */
     createDraft(id: string, options?: RequestOptions): APIPromise<Plan>;
     /**
      * Retrieves the list of charges configured on a plan.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListChargesResponse of client.v1.plans.listCharges(
+     *   'x',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
-    listCharges(id: string, query?: PlanListChargesParams | null | undefined, options?: RequestOptions): PagePromise<ChargeListDataMyCursorIDPage, AddonsAPI.ChargeList.Data>;
+    listCharges(id: string, query?: PlanListChargesParams | null | undefined, options?: RequestOptions): PagePromise<PlanListChargesResponsesMyCursorIDPage, PlanListChargesResponse>;
     /**
      * Retrieves the list of overage charges configured on a plan.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListOverageChargesResponse of client.v1.plans.listOverageCharges(
+     *   'x',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
-    listOverageCharges(id: string, query?: PlanListOverageChargesParams | null | undefined, options?: RequestOptions): PagePromise<ChargeListDataMyCursorIDPage, AddonsAPI.ChargeList.Data>;
+    listOverageCharges(id: string, query?: PlanListOverageChargesParams | null | undefined, options?: RequestOptions): PagePromise<PlanListOverageChargesResponsesMyCursorIDPage, PlanListOverageChargesResponse>;
     /**
      * Publishes a draft plan, making it available for use in subscriptions.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.plans.publish('x', {
+     *   migrationType: 'NEW_CUSTOMERS',
+     * });
+     * ```
      */
     publish(id: string, body: PlanPublishParams, options?: RequestOptions): APIPromise<PlanPublishResponse>;
     /**
      * Removes a draft version of a plan.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.plans.removeDraft('x');
+     * ```
      */
     removeDraft(id: string, options?: RequestOptions): APIPromise<PlanRemoveDraftResponse>;
 }
 export type PlanListResponsesMyCursorIDPage = MyCursorIDPage<PlanListResponse>;
+export type PlanListChargesResponsesMyCursorIDPage = MyCursorIDPage<PlanListChargesResponse>;
+export type PlanListOverageChargesResponsesMyCursorIDPage = MyCursorIDPage<PlanListOverageChargesResponse>;
 /**
  * Response object
  */
@@ -298,6 +367,334 @@ export declare namespace PlanListResponse {
         type: 'FEATURE' | 'CREDIT';
     }
 }
+/**
+ * A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
+ * billingModel, billingCadence, billingCountryCode) combination. Plans and addons
+ * own many of these — one per currency / billing period / feature.
+ */
+export interface PlanListChargesResponse {
+    /**
+     * Unique identifier of the charge
+     */
+    id: string;
+    /**
+     * The billing cadence (RECURRING or ONE_OFF)
+     */
+    billingCadence: 'RECURRING' | 'ONE_OFF';
+    /**
+     * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
+     */
+    billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
+    /**
+     * The billing period (MONTHLY or ANNUALLY)
+     */
+    billingPeriod: 'MONTHLY' | 'ANNUALLY';
+    /**
+     * Timestamp when the charge was created
+     */
+    createdAt: string;
+    /**
+     * ISO country code for localized pricing, if any
+     */
+    billingCountryCode?: string | null;
+    /**
+     * Identifier in the external billing integration (e.g. Stripe price id), if any
+     */
+    billingId?: string | null;
+    /**
+     * Block size for usage-based pricing
+     */
+    blockSize?: number | null;
+    /**
+     * When credits are granted (for credit-based pricing)
+     */
+    creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
+    /**
+     * Credit rate configuration for credit-based pricing
+     */
+    creditRate?: PlanListChargesResponse.CreditRate | null;
+    /**
+     * Identifier in the linked CRM, if any
+     */
+    crmId?: string | null;
+    /**
+     * Deep link to the charge in the linked CRM, if any
+     */
+    crmLinkUrl?: string | null;
+    /**
+     * The feature this charge meters, if metered
+     */
+    featureId?: string | null;
+    /**
+     * Maximum unit quantity that can be purchased
+     */
+    maxUnitQuantity?: number | null;
+    /**
+     * Minimum unit quantity that can be purchased
+     */
+    minUnitQuantity?: number | null;
+    /**
+     * The flat price amount and currency, when applicable
+     */
+    price?: PlanListChargesResponse.Price | null;
+    /**
+     * Tiered pricing rows when the charge is tiered
+     */
+    tiers?: Array<PlanListChargesResponse.Tier> | null;
+    /**
+     * Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
+     */
+    tiersMode?: 'VOLUME' | 'GRADUATED' | null;
+    /**
+     * Custom currency identifier for top-up pricing, if any
+     */
+    topUpCustomCurrencyId?: string | null;
+    /**
+     * True if this charge is referenced by at least one subscription
+     */
+    usedInSubscriptions?: boolean | null;
+}
+export declare namespace PlanListChargesResponse {
+    /**
+     * Credit rate configuration for credit-based pricing
+     */
+    interface CreditRate {
+        /**
+         * Credit rate amount
+         */
+        amount: number;
+        /**
+         * Custom currency identifier
+         */
+        currencyId: string;
+        /**
+         * Optional cost formula expression
+         */
+        costFormula?: string | null;
+    }
+    /**
+     * The flat price amount and currency, when applicable
+     */
+    interface Price {
+        /**
+         * The price amount
+         */
+        amount: number;
+        /**
+         * ISO 4217 currency code
+         */
+        currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+    }
+    /**
+     * A single tier within a tiered charge
+     */
+    interface Tier {
+        /**
+         * Flat price for this tier
+         */
+        flatPrice?: Tier.FlatPrice | null;
+        /**
+         * Per-unit price in this tier
+         */
+        unitPrice?: Tier.UnitPrice | null;
+        /**
+         * Upper bound of this tier (null for unlimited)
+         */
+        upTo?: number | null;
+    }
+    namespace Tier {
+        /**
+         * Flat price for this tier
+         */
+        interface FlatPrice {
+            /**
+             * The price amount
+             */
+            amount: number;
+            /**
+             * ISO 4217 currency code
+             */
+            currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+        }
+        /**
+         * Per-unit price in this tier
+         */
+        interface UnitPrice {
+            /**
+             * The price amount
+             */
+            amount: number;
+            /**
+             * ISO 4217 currency code
+             */
+            currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+        }
+    }
+}
+/**
+ * A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
+ * billingModel, billingCadence, billingCountryCode) combination. Plans and addons
+ * own many of these — one per currency / billing period / feature.
+ */
+export interface PlanListOverageChargesResponse {
+    /**
+     * Unique identifier of the charge
+     */
+    id: string;
+    /**
+     * The billing cadence (RECURRING or ONE_OFF)
+     */
+    billingCadence: 'RECURRING' | 'ONE_OFF';
+    /**
+     * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
+     */
+    billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
+    /**
+     * The billing period (MONTHLY or ANNUALLY)
+     */
+    billingPeriod: 'MONTHLY' | 'ANNUALLY';
+    /**
+     * Timestamp when the charge was created
+     */
+    createdAt: string;
+    /**
+     * ISO country code for localized pricing, if any
+     */
+    billingCountryCode?: string | null;
+    /**
+     * Identifier in the external billing integration (e.g. Stripe price id), if any
+     */
+    billingId?: string | null;
+    /**
+     * Block size for usage-based pricing
+     */
+    blockSize?: number | null;
+    /**
+     * When credits are granted (for credit-based pricing)
+     */
+    creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
+    /**
+     * Credit rate configuration for credit-based pricing
+     */
+    creditRate?: PlanListOverageChargesResponse.CreditRate | null;
+    /**
+     * Identifier in the linked CRM, if any
+     */
+    crmId?: string | null;
+    /**
+     * Deep link to the charge in the linked CRM, if any
+     */
+    crmLinkUrl?: string | null;
+    /**
+     * The feature this charge meters, if metered
+     */
+    featureId?: string | null;
+    /**
+     * Maximum unit quantity that can be purchased
+     */
+    maxUnitQuantity?: number | null;
+    /**
+     * Minimum unit quantity that can be purchased
+     */
+    minUnitQuantity?: number | null;
+    /**
+     * The flat price amount and currency, when applicable
+     */
+    price?: PlanListOverageChargesResponse.Price | null;
+    /**
+     * Tiered pricing rows when the charge is tiered
+     */
+    tiers?: Array<PlanListOverageChargesResponse.Tier> | null;
+    /**
+     * Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
+     */
+    tiersMode?: 'VOLUME' | 'GRADUATED' | null;
+    /**
+     * Custom currency identifier for top-up pricing, if any
+     */
+    topUpCustomCurrencyId?: string | null;
+    /**
+     * True if this charge is referenced by at least one subscription
+     */
+    usedInSubscriptions?: boolean | null;
+}
+export declare namespace PlanListOverageChargesResponse {
+    /**
+     * Credit rate configuration for credit-based pricing
+     */
+    interface CreditRate {
+        /**
+         * Credit rate amount
+         */
+        amount: number;
+        /**
+         * Custom currency identifier
+         */
+        currencyId: string;
+        /**
+         * Optional cost formula expression
+         */
+        costFormula?: string | null;
+    }
+    /**
+     * The flat price amount and currency, when applicable
+     */
+    interface Price {
+        /**
+         * The price amount
+         */
+        amount: number;
+        /**
+         * ISO 4217 currency code
+         */
+        currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+    }
+    /**
+     * A single tier within a tiered charge
+     */
+    interface Tier {
+        /**
+         * Flat price for this tier
+         */
+        flatPrice?: Tier.FlatPrice | null;
+        /**
+         * Per-unit price in this tier
+         */
+        unitPrice?: Tier.UnitPrice | null;
+        /**
+         * Upper bound of this tier (null for unlimited)
+         */
+        upTo?: number | null;
+    }
+    namespace Tier {
+        /**
+         * Flat price for this tier
+         */
+        interface FlatPrice {
+            /**
+             * The price amount
+             */
+            amount: number;
+            /**
+             * ISO 4217 currency code
+             */
+            currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+        }
+        /**
+         * Per-unit price in this tier
+         */
+        interface UnitPrice {
+            /**
+             * The price amount
+             */
+            amount: number;
+            /**
+             * ISO 4217 currency code
+             */
+            currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
+        }
+    }
+}
 /**
  * Response containing task ID for publish operation
  */
@@ -985,8 +1382,7 @@ export interface PlanPublishParams {
     migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
 }
 export declare namespace Plans {
-    export { type Plan as Plan, type PlanListResponse as PlanListResponse, type PlanPublishResponse as PlanPublishResponse, type PlanRemoveDraftResponse as PlanRemoveDraftResponse, type PlanListResponsesMyCursorIDPage as PlanListResponsesMyCursorIDPage, type PlanCreateParams as PlanCreateParams, type PlanUpdateParams as PlanUpdateParams, type PlanListParams as PlanListParams, type PlanListChargesParams as PlanListChargesParams, type PlanListOverageChargesParams as PlanListOverageChargesParams, type PlanPublishParams as PlanPublishParams, };
+    export { type Plan as Plan, type PlanListResponse as PlanListResponse, type PlanListChargesResponse as PlanListChargesResponse, type PlanListOverageChargesResponse as PlanListOverageChargesResponse, type PlanPublishResponse as PlanPublishResponse, type PlanRemoveDraftResponse as PlanRemoveDraftResponse, type PlanListResponsesMyCursorIDPage as PlanListResponsesMyCursorIDPage, type PlanListChargesResponsesMyCursorIDPage as PlanListChargesResponsesMyCursorIDPage, type PlanListOverageChargesResponsesMyCursorIDPage as PlanListOverageChargesResponsesMyCursorIDPage, type PlanCreateParams as PlanCreateParams, type PlanUpdateParams as PlanUpdateParams, type PlanListParams as PlanListParams, type PlanListChargesParams as PlanListChargesParams, type PlanListOverageChargesParams as PlanListOverageChargesParams, type PlanPublishParams as PlanPublishParams, };
     export { Entitlements as Entitlements, type PlanEntitlement as PlanEntitlement, type EntitlementCreateResponse as EntitlementCreateResponse, type EntitlementListResponse as EntitlementListResponse, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementDeleteParams as EntitlementDeleteParams, };
 }
-export { type ChargeListDataMyCursorIDPage };
 //# sourceMappingURL=plans.d.mts.map