stripe 19.1.0 → 19.2.0-alpha.1

package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts

@@ -0,0 +1,197 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        namespace PricingPlans {
+          interface ComponentCreateParams {
+            /**
+             * The type of the PricingPlanComponent.
+             */
+            type: ComponentCreateParams.Type;
+
+            /**
+             * Details if this component is a License Fee.
+             */
+            license_fee?: ComponentCreateParams.LicenseFee;
+
+            /**
+             * An identifier that can be used to find this component.
+             */
+            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?: Stripe.MetadataParam;
+
+            /**
+             * Details if this component is a Rate Card.
+             */
+            rate_card?: ComponentCreateParams.RateCard;
+
+            /**
+             * Details if this component is a Service Action.
+             */
+            service_action?: ComponentCreateParams.ServiceAction;
+          }
+
+          namespace ComponentCreateParams {
+            interface LicenseFee {
+              /**
+               * The ID of the License Fee.
+               */
+              id: string;
+
+              /**
+               * The version of the LicenseFee. Defaults to 'latest', if not specified.
+               */
+              version?: string;
+            }
+
+            interface RateCard {
+              /**
+               * The ID of the Rate Card.
+               */
+              id: string;
+
+              /**
+               * The version of the RateCard. Defaults to 'latest', if not specified.
+               */
+              version?: string;
+            }
+
+            interface ServiceAction {
+              /**
+               * The ID of the service action.
+               */
+              id: string;
+            }
+
+            type Type = 'license_fee' | 'rate_card' | 'service_action';
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlans {
+          interface ComponentRetrieveParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlans {
+          interface ComponentUpdateParams {
+            /**
+             * An identifier that can be used to find this component. Maximum length of 200 characters.
+             */
+            lookup_key?: string;
+
+            /**
+             * Set of key-value pairs that you can attach to an object.
+             */
+            metadata?: Stripe.MetadataParam;
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlans {
+          interface ComponentListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 20.
+             */
+            limit?: number;
+
+            /**
+             * Filter by lookup keys. Mutually exclusive with `pricing_plan_version`.
+             * You can specify up to 10 lookup keys.
+             */
+            lookup_keys?: Array<string>;
+
+            /**
+             * The ID of the Pricing Plan Version to list components for. Will use the latest version if not provided.
+             * Mutually exclusive with `lookup_keys`.
+             */
+            pricing_plan_version?: string;
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlans {
+          interface ComponentDeleteParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlans {
+          class ComponentsResource {
+            /**
+             * Create a Pricing Plan Component object.
+             */
+            create(
+              id: string,
+              params: ComponentCreateParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlanComponent>>;
+
+            /**
+             * Retrieve a Pricing Plan Component object.
+             */
+            retrieve(
+              pricingPlanId: string,
+              id: string,
+              params?: ComponentRetrieveParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlanComponent>>;
+            retrieve(
+              pricingPlanId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlanComponent>>;
+
+            /**
+             * Update a Pricing Plan Component object.
+             */
+            update(
+              pricingPlanId: string,
+              id: string,
+              params?: ComponentUpdateParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlanComponent>>;
+
+            /**
+             * List all Pricing Plan Component objects for a Pricing Plan.
+             */
+            list(
+              id: string,
+              params?: ComponentListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.PricingPlanComponent>;
+            list(
+              id: string,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.PricingPlanComponent>;
+
+            /**
+             * Remove a Pricing Plan Component from the latest version of a Pricing Plan.
+             */
+            del(
+              pricingPlanId: string,
+              id: string,
+              params?: ComponentDeleteParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
+            del(
+              pricingPlanId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/PricingPlans/VersionsResource.d.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        namespace PricingPlans {
+          interface VersionRetrieveParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlans {
+          interface VersionListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 20.
+             */
+            limit?: number;
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace PricingPlans {
+          class VersionsResource {
+            /**
+             * Retrieve a specific Pricing Plan Version of a Pricing Plan.
+             */
+            retrieve(
+              pricingPlanId: string,
+              id: string,
+              params?: VersionRetrieveParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlanVersion>>;
+            retrieve(
+              pricingPlanId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlanVersion>>;
+
+            /**
+             * List all Pricing Plan Versions of a Pricing Plan.
+             */
+            list(
+              id: string,
+              params?: VersionListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.PricingPlanVersion>;
+            list(
+              id: string,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.PricingPlanVersion>;
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/PricingPlans.d.ts

@@ -0,0 +1,84 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The PricingPlan object.
+         */
+        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 for pricing plan subscription.
+           * 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?: Stripe.Metadata;
+
+          /**
+           * The Stripe Tax tax behavior - whether the PricingPlan is inclusive or exclusive of tax.
+           */
+          tax_behavior: PricingPlan.TaxBehavior;
+        }
+
+        namespace PricingPlan {
+          type TaxBehavior = 'exclusive' | 'inclusive';
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/PricingPlansResource.d.ts

@@ -0,0 +1,151 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    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 Stripe Tax tax behavior - whether the PricingPlan is inclusive or exclusive of tax.
+           */
+          tax_behavior: PricingPlanCreateParams.TaxBehavior;
+
+          /**
+           * Description of pricing plan subscription.
+           */
+          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?: Stripe.MetadataParam;
+        }
+
+        namespace PricingPlanCreateParams {
+          type TaxBehavior = 'exclusive' | 'inclusive';
+        }
+      }
+
+      namespace Billing {
+        interface PricingPlanRetrieveParams {}
+      }
+
+      namespace Billing {
+        interface PricingPlanUpdateParams {
+          /**
+           * Whether the PricingPlan is active.
+           */
+          active?: boolean;
+
+          /**
+           * Description of pricing plan subscription.
+           */
+          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?: Stripe.MetadataParam;
+        }
+      }
+
+      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>;
+        }
+      }
+
+      namespace Billing {
+        class PricingPlansResource {
+          components: Stripe.V2.Billing.PricingPlans.ComponentsResource;
+          versions: Stripe.V2.Billing.PricingPlans.VersionsResource;
+
+          /**
+           * Create a Pricing Plan object.
+           */
+          create(
+            params: PricingPlanCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlan>>;
+
+          /**
+           * Retrieve a Pricing Plan object.
+           */
+          retrieve(
+            id: string,
+            params?: PricingPlanRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlan>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlan>>;
+
+          /**
+           * Update a Pricing Plan object.
+           */
+          update(
+            id: string,
+            params?: PricingPlanUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.PricingPlan>>;
+
+          /**
+           * List all Pricing Plan objects.
+           */
+          list(
+            params?: PricingPlanListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Billing.PricingPlan>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Billing.PricingPlan>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/Profiles.d.ts

@@ -0,0 +1,70 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The Profile object.
+         */
+        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?: Stripe.Metadata;
+
+          /**
+           * The current status of the billing profile.
+           */
+          status: Profile.Status;
+        }
+
+        namespace Profile {
+          type Status = 'active' | 'inactive';
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/ProfilesResource.d.ts

@@ -0,0 +1,150 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    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?: Stripe.MetadataParam;
+        }
+      }
+
+      namespace Billing {
+        interface ProfileRetrieveParams {}
+      }
+
+      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?: Stripe.MetadataParam;
+        }
+      }
+
+      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 will be returned.
+           */
+          status?: ProfileListParams.Status;
+        }
+
+        namespace ProfileListParams {
+          type Status = 'active' | 'inactive';
+        }
+      }
+
+      namespace Billing {
+        class ProfilesResource {
+          /**
+           * Create a BillingProfile object.
+           */
+          create(
+            params: ProfileCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
+
+          /**
+           * Retrieve a BillingProfile object.
+           */
+          retrieve(
+            id: string,
+            params?: ProfileRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
+
+          /**
+           * Update a BillingProfile object.
+           */
+          update(
+            id: string,
+            params?: ProfileUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
+
+          /**
+           * List Billing Profiles.
+           */
+          list(
+            params: ProfileListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Billing.Profile>;
+        }
+      }
+    }
+  }
+}