stripe 22.1.0 → 22.2.0-alpha.2

package/cjs/resources/V2/Billing/PricingPlans.d.ts

@@ -0,0 +1,177 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { MetadataParam, Metadata } from '../../../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../../../lib.js';
+import { ComponentResource } from './PricingPlans/Components.js';
+import { VersionResource } from './PricingPlans/Versions.js';
+import { Stripe } from '../../../stripe.core.js';
+export declare class PricingPlanResource extends StripeResource {
+    private readonly stripe;
+    components: ComponentResource;
+    versions: VersionResource;
+    constructor(stripe: Stripe);
+    /**
+     * List all Pricing Plan objects.
+     */
+    list(params?: V2.Billing.PricingPlanListParams, options?: RequestOptions): ApiListPromise<PricingPlan>;
+    /**
+     * Create a Pricing Plan object.
+     */
+    create(params: V2.Billing.PricingPlanCreateParams, options?: RequestOptions): Promise<Response<PricingPlan>>;
+    /**
+     * Retrieve a Pricing Plan object.
+     */
+    retrieve(id: string, params?: V2.Billing.PricingPlanRetrieveParams, options?: RequestOptions): Promise<Response<PricingPlan>>;
+    /**
+     * Update a Pricing Plan object.
+     */
+    update(id: string, params?: V2.Billing.PricingPlanUpdateParams, options?: RequestOptions): Promise<Response<PricingPlan>>;
+}
+export interface PricingPlan {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.billing.pricing_plan';
+    /**
+     * Whether the PricingPlan is active.
+     */
+    active: boolean;
+    /**
+     * Time at which the object was created.
+     */
+    created: string;
+    /**
+     * The currency of the PricingPlan.
+     */
+    currency: string;
+    /**
+     * A description of the pricing plan. Maximum length of 500 characters.
+     */
+    description?: string;
+    /**
+     * Display name of the PricingPlan.
+     */
+    display_name: string;
+    /**
+     * The ID of the latest version of the PricingPlan.
+     */
+    latest_version: string;
+    /**
+     * The ID of the live version of the PricingPlan.
+     */
+    live_version?: string;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * An internal key you can use to search for a particular PricingPlan. Maximum length of 200 characters.
+     */
+    lookup_key?: string;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+     */
+    metadata?: Metadata;
+    /**
+     * The tax behavior for Stripe Tax — whether the pricing plan price includes or excludes tax.
+     */
+    tax_behavior: V2.Billing.PricingPlan.TaxBehavior;
+}
+export declare namespace V2 {
+    namespace Billing {
+        namespace PricingPlan {
+            type TaxBehavior = 'exclusive' | 'inclusive';
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface PricingPlanCreateParams {
+            /**
+             * The currency of the PricingPlan.
+             */
+            currency: string;
+            /**
+             * Display name of the PricingPlan. Maximum 250 characters.
+             */
+            display_name: string;
+            /**
+             * The tax behavior for Stripe Tax — whether the pricing plan price includes or excludes tax.
+             */
+            tax_behavior: PricingPlanCreateParams.TaxBehavior;
+            /**
+             * Description of the pricing plan. Maximum length of 500 characters.
+             */
+            description?: string;
+            /**
+             * An internal key you can use to search for a particular PricingPlan. Maximum length of 200 characters.
+             */
+            lookup_key?: string;
+            /**
+             * Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+             */
+            metadata?: MetadataParam;
+        }
+        namespace PricingPlanCreateParams {
+            type TaxBehavior = 'exclusive' | 'inclusive';
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface PricingPlanRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface PricingPlanUpdateParams {
+            /**
+             * Whether the PricingPlan is active.
+             */
+            active?: boolean;
+            /**
+             * Description of the pricing plan. Maximum length of 500 characters.
+             */
+            description?: string;
+            /**
+             * Display name of the PricingPlan. Maximum 250 characters.
+             */
+            display_name?: string;
+            /**
+             * The ID of the live version of the PricingPlan.
+             */
+            live_version?: string;
+            /**
+             * An internal key you can use to search for a particular PricingPlan. Maximum length of 200 characters.
+             */
+            lookup_key?: string;
+            /**
+             * Set of key-value pairs that you can attach to an object.
+             */
+            metadata?: MetadataParam;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface PricingPlanListParams {
+            /**
+             * Filter for active/inactive PricingPlans. Mutually exclusive with `lookup_keys`.
+             */
+            active?: boolean;
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 20.
+             */
+            limit?: number;
+            /**
+             * Filter by lookup keys. Mutually exclusive with `active`.
+             * You can specify up to 10 lookup keys.
+             */
+            lookup_keys?: Array<string>;
+        }
+    }
+}

package/cjs/resources/V2/Billing/PricingPlans.js

@@ -0,0 +1,43 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPlanResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+const Components_js_1 = require("./PricingPlans/Components.js");
+const Versions_js_1 = require("./PricingPlans/Versions.js");
+class PricingPlanResource extends StripeResource_js_1.StripeResource {
+    constructor(stripe) {
+        super(stripe);
+        this.stripe = stripe;
+        this.components = new Components_js_1.ComponentResource(stripe);
+        this.versions = new Versions_js_1.VersionResource(stripe);
+    }
+    /**
+     * List all Pricing Plan objects.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/billing/pricing_plans', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create a Pricing Plan object.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/billing/pricing_plans', params, options);
+    }
+    /**
+     * Retrieve a Pricing Plan object.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/billing/pricing_plans/${id}`, params, options);
+    }
+    /**
+     * Update a Pricing Plan object.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v2/billing/pricing_plans/${id}`, params, options);
+    }
+}
+exports.PricingPlanResource = PricingPlanResource;
+//# sourceMappingURL=PricingPlans.js.map

package/cjs/resources/V2/Billing/PricingPlans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PricingPlans.js","sourceRoot":"","sources":["../../../../src/resources/V2/Billing/PricingPlans.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAG1D,gEAA+D;AAC/D,4DAA2D;AAE3D,MAAa,mBAAoB,SAAQ,kCAAc;IAIrD,YAA6B,MAAc;QACzC,KAAK,CAAC,MAAM,CAAC,CAAC;QADa,WAAM,GAAN,MAAM,CAAQ;QAEzC,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAiB,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD;;OAEG;IACH,IAAI,CACF,MAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,2BAA2B,EAC3B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,2BAA2B,EAC3B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,6BAA6B,EAAE,EAAE,EACjC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,6BAA6B,EAAE,EAAE,EACjC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAtED,kDAsEC"}

package/cjs/resources/V2/Billing/Profiles.d.ts

@@ -0,0 +1,166 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { MetadataParam, Metadata } from '../../../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../../../lib.js';
+export declare class ProfileResource extends StripeResource {
+    /**
+     * List Billing Profiles.
+     */
+    list(params: V2.Billing.ProfileListParams, options?: RequestOptions): ApiListPromise<Profile>;
+    /**
+     * Create a BillingProfile object.
+     */
+    create(params: V2.Billing.ProfileCreateParams, options?: RequestOptions): Promise<Response<Profile>>;
+    /**
+     * Retrieve a BillingProfile object.
+     */
+    retrieve(id: string, params?: V2.Billing.ProfileRetrieveParams, options?: RequestOptions): Promise<Response<Profile>>;
+    /**
+     * Update a BillingProfile object.
+     */
+    update(id: string, params?: V2.Billing.ProfileUpdateParams, options?: RequestOptions): Promise<Response<Profile>>;
+}
+export interface Profile {
+    /**
+     * The ID of the billing profile object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.billing.profile';
+    /**
+     * Timestamp of when the object was created.
+     */
+    created: string;
+    /**
+     * The ID of the customer object.
+     */
+    customer?: string;
+    /**
+     * The ID of the payment method object.
+     */
+    default_payment_method?: string;
+    /**
+     * A customer-facing name for the billing profile.
+     * Maximum length of 250 characters.
+     */
+    display_name?: string;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * An internal key you can use to search for a particular billing profile.
+     * Maximum length of 200 characters.
+     */
+    lookup_key?: string;
+    /**
+     * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+     */
+    metadata?: Metadata;
+    /**
+     * The current status of the billing profile.
+     */
+    status: V2.Billing.Profile.Status;
+}
+export declare namespace V2 {
+    namespace Billing {
+        namespace Profile {
+            type Status = 'active' | 'inactive';
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface ProfileCreateParams {
+            /**
+             * The ID of the customer object.
+             */
+            customer: string;
+            /**
+             * The ID of the payment method object.
+             */
+            default_payment_method?: string;
+            /**
+             * A customer-facing name for the billing profile.
+             * Maximum length of 250 characters.
+             */
+            display_name?: string;
+            /**
+             * An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
+             * Maximum length of 200 characters.
+             */
+            lookup_key?: string;
+            /**
+             * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+             */
+            metadata?: MetadataParam;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface ProfileRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface ProfileUpdateParams {
+            /**
+             * The ID of the payment method object.
+             */
+            default_payment_method?: string;
+            /**
+             * A customer-facing name for the billing profile.
+             * Maximum length of 250 characters.
+             * To remove the display_name from the object, set it to null in the request.
+             */
+            display_name?: string;
+            /**
+             * An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
+             * Maximum length of 200 characters.
+             * To remove the lookup_key from the object, set it to null in the request.
+             */
+            lookup_key?: string;
+            /**
+             * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+             */
+            metadata?: MetadataParam;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface ProfileListParams {
+            /**
+             * Filter billing profiles by lookup keys. Mutually exclusive
+             * with `customer` and `default_payment_method`.
+             * You can specify up to 10 lookup_keys.
+             */
+            lookup_keys: Array<string>;
+            /**
+             * Filter billing profiles by a customer. Mutually exclusive
+             * with `lookup_keys` and `default_payment_method`.
+             */
+            customer?: string;
+            /**
+             * Filter billing profiles by a default payment method. Mutually exclusive
+             * with `customer` and `lookup_keys`.
+             */
+            default_payment_method?: string;
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 10.
+             */
+            limit?: number;
+            /**
+             * Filter billing profiles by status. Can be combined
+             * with all other filters. If not provided, all billing profiles are returned.
+             */
+            status?: ProfileListParams.Status;
+        }
+        namespace ProfileListParams {
+            type Status = 'active' | 'inactive';
+        }
+    }
+}

package/cjs/resources/V2/Billing/Profiles.js

@@ -0,0 +1,35 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProfileResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class ProfileResource extends StripeResource_js_1.StripeResource {
+    /**
+     * List Billing Profiles.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/billing/profiles', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create a BillingProfile object.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/billing/profiles', params, options);
+    }
+    /**
+     * Retrieve a BillingProfile object.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/billing/profiles/${id}`, params, options);
+    }
+    /**
+     * Update a BillingProfile object.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v2/billing/profiles/${id}`, params, options);
+    }
+}
+exports.ProfileResource = ProfileResource;
+//# sourceMappingURL=Profiles.js.map

package/cjs/resources/V2/Billing/Profiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Profiles.js","sourceRoot":"","sources":["../../../../src/resources/V2/Billing/Profiles.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAI1D,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,IAAI,CACF,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,sBAAsB,EAAE,MAAM,EAAE,OAAO,EAAE;YACvE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sBAAsB,EACtB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,wBAAwB,EAAE,EAAE,EAC5B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,wBAAwB,EAAE,EAAE,EAC5B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAxDD,0CAwDC"}

package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts

@@ -0,0 +1,45 @@
+import { OneTimeItem } from './OneTimeItems.js';
+import { Metadata } from '../../../shared.js';
+export interface RateCardCustomPricingUnitOverageRate {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.billing.rate_card_custom_pricing_unit_overage_rate';
+    /**
+     * Timestamp of when the object was created.
+     */
+    created: string;
+    /**
+     * The ID of the custom pricing unit this overage rate applies to.
+     */
+    custom_pricing_unit: string;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+     */
+    metadata?: Metadata;
+    /**
+     * A one-time item represents a product that can be charged as a one-time line item,
+     * used for overage charges when custom pricing unit credits are exhausted.
+     */
+    one_time_item: OneTimeItem;
+    /**
+     * The ID of the Rate Card this overage rate belongs to.
+     */
+    rate_card: string;
+    /**
+     * The ID of the Rate Card Version this overage rate was created on.
+     */
+    rate_card_version: string;
+    /**
+     * The per-unit amount to charge for overages, represented as a decimal string in minor currency units with at most 12 decimal places.
+     */
+    unit_amount: string;
+}

package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js

@@ -0,0 +1,4 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RateCardCustomPricingUnitOverageRates.js.map

package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateCardCustomPricingUnitOverageRates.js","sourceRoot":"","sources":["../../../../src/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.ts"],"names":[],"mappings":";AAAA,uCAAuC"}

package/cjs/resources/V2/Billing/RateCardRates.d.ts

@@ -0,0 +1,115 @@
+import { MeteredItem } from './MeteredItems.js';
+import { CustomPricingUnit } from './CustomPricingUnits.js';
+import { Metadata, Decimal } from '../../../shared.js';
+export interface RateCardRate {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.billing.rate_card_rate';
+    /**
+     * Timestamp of when the object was created.
+     */
+    created: string;
+    /**
+     * The custom pricing unit that this rate binds to.
+     */
+    custom_pricing_unit_amount?: V2.Billing.RateCardRate.CustomPricingUnitAmount;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+     */
+    metadata?: Metadata;
+    /**
+     * A Metered Item represents a billable item whose pricing is based on usage, measured by a meter. You can use rate cards
+     * to specify the pricing and create subscriptions to these items.
+     */
+    metered_item: MeteredItem;
+    /**
+     * The ID of the Rate Card it belongs to.
+     */
+    rate_card: string;
+    /**
+     * The ID of the Rate Card Version it was created on.
+     */
+    rate_card_version: string;
+    /**
+     * Defines whether the tiering price is graduated or volume-based. In volume-based tiering, the maximum
+     * quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity
+     * grows into new tiers. Can only be set if `tiers` is set.
+     */
+    tiering_mode?: V2.Billing.RateCardRate.TieringMode;
+    /**
+     * Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+     */
+    tiers: Array<V2.Billing.RateCardRate.Tier>;
+    /**
+     * Apply a transformation to the reported usage or set quantity before computing the amount billed.
+     */
+    transform_quantity?: V2.Billing.RateCardRate.TransformQuantity;
+    /**
+     * The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal
+     * places. Cannot be set if `tiers` is provided.
+     */
+    unit_amount?: string;
+}
+export declare namespace V2 {
+    namespace Billing {
+        namespace RateCardRate {
+            interface CustomPricingUnitAmount {
+                /**
+                 * The Custom Pricing Unit object.
+                 */
+                custom_pricing_unit_details?: CustomPricingUnit;
+                /**
+                 * The id of the custom pricing unit.
+                 */
+                id: string;
+                /**
+                 * The unit value for the custom pricing unit, as a string.
+                 */
+                value: string;
+            }
+            type TieringMode = 'graduated' | 'volume';
+            interface Tier {
+                /**
+                 * Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
+                 */
+                flat_amount?: string;
+                /**
+                 * Per-unit price for units included in this tier, represented as a decimal string in minor currency units with at
+                 * most 12 decimal places.
+                 */
+                unit_amount?: string;
+                /**
+                 * Up to and including this quantity is contained in the tier. Only one of `up_to_decimal` and `up_to_inf` may
+                 * be set.
+                 */
+                up_to_decimal?: Decimal;
+                /**
+                 * No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+                 */
+                up_to_inf?: 'inf';
+            }
+            interface TransformQuantity {
+                /**
+                 * Divide usage by this number.
+                 */
+                divide_by: bigint;
+                /**
+                 * After division, round the result up or down.
+                 */
+                round: TransformQuantity.Round;
+            }
+            namespace TransformQuantity {
+                type Round = 'down' | 'up';
+            }
+        }
+    }
+}

package/cjs/resources/V2/Billing/RateCardRates.js

@@ -0,0 +1,4 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RateCardRates.js.map

package/cjs/resources/V2/Billing/RateCardRates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateCardRates.js","sourceRoot":"","sources":["../../../../src/resources/V2/Billing/RateCardRates.ts"],"names":[],"mappings":";AAAA,uCAAuC"}