stripe 19.1.0-alpha.1 → 19.1.0

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

@@ -1,58 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        namespace RateCards {
-          interface VersionRetrieveParams {}
-        }
-      }
-
-      namespace Billing {
-        namespace RateCards {
-          interface VersionListParams {
-            /**
-             * Optionally set the maximum number of results per page. Defaults to 20.
-             */
-            limit?: number;
-          }
-        }
-      }
-
-      namespace Billing {
-        namespace RateCards {
-          class VersionsResource {
-            /**
-             * Retrieve a specific version of a Rate Card object.
-             */
-            retrieve(
-              rateCardId: string,
-              id: string,
-              params?: VersionRetrieveParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardVersion>>;
-            retrieve(
-              rateCardId: string,
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardVersion>>;
-
-            /**
-             * List the versions of a Rate Card object. Results are sorted in reverse chronological order (most recent first).
-             */
-            list(
-              id: string,
-              params?: VersionListParams,
-              options?: RequestOptions
-            ): ApiListPromise<Stripe.V2.Billing.RateCardVersion>;
-            list(
-              id: string,
-              options?: RequestOptions
-            ): ApiListPromise<Stripe.V2.Billing.RateCardVersion>;
-          }
-        }
-      }
-    }
-  }
-}

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

@@ -1,98 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        /**
-         * A Rate Card represents a versioned set of usage-based prices (rates). Each rate is associated with one Metered Item and
-         * defines how much to charge for usage of that item. After you've set up a RateCard, you can subscribe customers to it
-         * by creating a Rate Card Subscription.
-         */
-        interface RateCard {
-          /**
-           * 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';
-
-          /**
-           * Whether this RateCard is active. Inactive RateCards cannot be used in new activations or have new rates added.
-           */
-          active: boolean;
-
-          /**
-           * Timestamp of when the object was created.
-           */
-          created: string;
-
-          /**
-           * Three-letter ISO currency code, in lowercase. Must be a supported currency.
-           */
-          currency: string;
-
-          /**
-           * A customer-facing name for the Rate Card.
-           * This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices.
-           * Maximum length of 250 characters.
-           */
-          display_name: string;
-
-          /**
-           * The ID of this rate card's most recently created version.
-           */
-          latest_version: string;
-
-          /**
-           * The ID of the Rate Card Version that will be used by all subscriptions when no specific version is specified.
-           */
-          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 RateCard. 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 interval for assessing service. For example, a monthly Rate Card with a rate of $1 for the first 10 "workloads"
-           * and $2 thereafter means "$1 per workload up to 10 workloads during a month of service." This is similar to but
-           * distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees,
-           * while the billing interval in Cadence deals with the rate the customer is billed.
-           */
-          service_interval: RateCard.ServiceInterval;
-
-          /**
-           * The length of the interval for assessing service. For example, set this to 3 and `service_interval` to `"month"` in
-           * order to specify quarterly service.
-           */
-          service_interval_count: number;
-
-          /**
-           * The Stripe Tax tax behavior - whether the rates are inclusive or exclusive of tax.
-           */
-          tax_behavior: RateCard.TaxBehavior;
-        }
-
-        namespace RateCard {
-          type ServiceInterval = 'day' | 'month' | 'week' | 'year';
-
-          type TaxBehavior = 'exclusive' | 'inclusive';
-        }
-      }
-    }
-  }
-}

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

@@ -1,162 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        interface RateCardCreateParams {
-          /**
-           * The currency of this RateCard.
-           */
-          currency: string;
-
-          /**
-           * A customer-facing name for the RateCard.
-           * This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices.
-           * Maximum length of 250 characters.
-           */
-          display_name: string;
-
-          /**
-           * The interval for assessing service. For example, a monthly RateCard with a rate of $1 for the first 10 "workloads"
-           * and $2 thereafter means "$1 per workload up to 10 workloads during a month of service." This is similar to but
-           * distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees,
-           * while the billing interval in Cadence deals with the rate the customer is billed.
-           */
-          service_interval: RateCardCreateParams.ServiceInterval;
-
-          /**
-           * The length of the interval for assessing service. For example, set this to 3 and `service_interval` to `"month"` in
-           * order to specify quarterly service.
-           */
-          service_interval_count: number;
-
-          /**
-           * The Stripe Tax tax behavior - whether the rates are inclusive or exclusive of tax.
-           */
-          tax_behavior: RateCardCreateParams.TaxBehavior;
-
-          /**
-           * An internal key you can use to search for a particular RateCard. 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 RateCardCreateParams {
-          type ServiceInterval = 'day' | 'month' | 'week' | 'year';
-
-          type TaxBehavior = 'exclusive' | 'inclusive';
-        }
-      }
-
-      namespace Billing {
-        interface RateCardRetrieveParams {}
-      }
-
-      namespace Billing {
-        interface RateCardUpdateParams {
-          /**
-           * Sets whether the RateCard is active. Inactive RateCards cannot be used in new activations or have new rates added.
-           */
-          active?: boolean;
-
-          /**
-           * A customer-facing name for the RateCard.
-           * This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices.
-           * Maximum length of 250 characters.
-           */
-          display_name?: string;
-
-          /**
-           * Changes the version that new RateCard activations will use. Providing `live_version = "latest"` will set the
-           * RateCard's `live_version` to its latest version.
-           */
-          live_version?: string;
-
-          /**
-           * An internal key you can use to search for a particular RateCard. 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 Billing {
-        interface RateCardListParams {
-          /**
-           * Optionally filter to active/inactive RateCards.
-           */
-          active?: boolean;
-
-          /**
-           * Optionally set the maximum number of results per page. Defaults to 20.
-           */
-          limit?: number;
-
-          /**
-           * Filter by lookup keys.
-           * You can specify up to 10 lookup keys.
-           */
-          lookup_keys?: Array<string>;
-        }
-      }
-
-      namespace Billing {
-        class RateCardsResource {
-          rates: Stripe.V2.Billing.RateCards.RatesResource;
-          versions: Stripe.V2.Billing.RateCards.VersionsResource;
-
-          /**
-           * Create a Rate Card object.
-           */
-          create(
-            params: RateCardCreateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCard>>;
-
-          /**
-           * Retrieve the latest version of a Rate Card object.
-           */
-          retrieve(
-            id: string,
-            params?: RateCardRetrieveParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCard>>;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCard>>;
-
-          /**
-           * Update a Rate Card object.
-           */
-          update(
-            id: string,
-            params?: RateCardUpdateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCard>>;
-
-          /**
-           * List all Rate Card objects.
-           */
-          list(
-            params?: RateCardListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Billing.RateCard>;
-          list(
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Billing.RateCard>;
-        }
-      }
-    }
-  }
-}

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

@@ -1,274 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        /**
-         * The ServiceAction object.
-         */
-        interface ServiceAction {
-          /**
-           * 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.service_action';
-
-          /**
-           * Timestamp of when the object was created.
-           */
-          created: string;
-
-          /**
-           * Details for the credit grant. Provided only if `type` is "credit_grant".
-           */
-          credit_grant?: ServiceAction.CreditGrant;
-
-          /**
-           * Details for the credit grant per tenant. Provided only if `type` is "credit_grant_per_tenant".
-           */
-          credit_grant_per_tenant?: ServiceAction.CreditGrantPerTenant;
-
-          /**
-           * 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 this service action.
-           */
-          lookup_key?: string;
-
-          /**
-           * The interval for assessing service.
-           */
-          service_interval: ServiceAction.ServiceInterval;
-
-          /**
-           * The length of the interval for assessing service.
-           */
-          service_interval_count: number;
-
-          /**
-           * The type of the service action.
-           */
-          type: ServiceAction.Type;
-        }
-
-        namespace ServiceAction {
-          interface CreditGrant {
-            /**
-             * The amount of the credit grant.
-             */
-            amount: CreditGrant.Amount;
-
-            /**
-             * Defines the scope where the credit grant is applicable.
-             */
-            applicability_config: CreditGrant.ApplicabilityConfig;
-
-            /**
-             * The category of the credit grant.
-             */
-            category?: CreditGrant.Category;
-
-            /**
-             * The expiry configuration for the credit grant.
-             */
-            expiry_config: CreditGrant.ExpiryConfig;
-
-            /**
-             * A descriptive name shown in dashboard.
-             */
-            name: string;
-
-            /**
-             * The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
-             */
-            priority?: number;
-          }
-
-          namespace CreditGrant {
-            interface Amount {
-              /**
-               * The type of the credit grant amount. We currently support `monetary` and `custom_pricing_unit` billing credits.
-               */
-              type: Amount.Type;
-
-              /**
-               * The custom pricing unit amount of the credit grant. Required if `type` is `custom_pricing_unit`.
-               */
-              custom_pricing_unit?: Amount.CustomPricingUnit;
-
-              /**
-               * The monetary amount of the credit grant. Required if `type` is `monetary`.
-               */
-              monetary?: V2.Amount;
-            }
-
-            namespace Amount {
-              interface CustomPricingUnit {
-                /**
-                 * The Custom Pricing Unit object.
-                 */
-                custom_pricing_unit_details?: Stripe.V2.Billing.CustomPricingUnit;
-
-                /**
-                 * The id of the custom pricing unit.
-                 */
-                id: string;
-
-                /**
-                 * The value of the credit grant, decimal value represented as a string.
-                 */
-                value: string;
-              }
-
-              type Type = 'custom_pricing_unit' | 'monetary';
-            }
-
-            interface ApplicabilityConfig {
-              /**
-               * The applicability scope of the credit grant.
-               */
-              scope: ApplicabilityConfig.Scope;
-            }
-
-            namespace ApplicabilityConfig {
-              interface Scope {
-                /**
-                 * The billable items to apply the credit grant to.
-                 */
-                billable_items?: Array<string>;
-
-                /**
-                 * The price type that credit grants can apply to. We currently only support the `metered` price type. This will apply to metered prices and rate cards. Cannot be used in combination with `billable_items`.
-                 */
-                price_type?: 'metered';
-              }
-            }
-
-            type Category = 'paid' | 'promotional';
-
-            interface ExpiryConfig {
-              /**
-               * The type of the expiry configuration. We currently support `end_of_service_period`.
-               */
-              type: 'end_of_service_period';
-            }
-          }
-
-          interface CreditGrantPerTenant {
-            /**
-             * The amount of the credit grant.
-             */
-            amount: CreditGrantPerTenant.Amount;
-
-            /**
-             * Defines the scope where the credit grant is applicable.
-             */
-            applicability_config: CreditGrantPerTenant.ApplicabilityConfig;
-
-            /**
-             * The category of the credit grant.
-             */
-            category?: CreditGrantPerTenant.Category;
-
-            /**
-             * The expiry configuration for the credit grant.
-             */
-            expiry_config: CreditGrantPerTenant.ExpiryConfig;
-
-            /**
-             * Customer-facing name for the credit grant.
-             */
-            name: string;
-
-            /**
-             * The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
-             */
-            priority?: number;
-          }
-
-          namespace CreditGrantPerTenant {
-            interface Amount {
-              /**
-               * The type of the credit grant amount. We currently support `monetary` and `custom_pricing_unit` billing credits.
-               */
-              type: Amount.Type;
-
-              /**
-               * The custom pricing unit amount of the credit grant. Required if `type` is `custom_pricing_unit`.
-               */
-              custom_pricing_unit?: Amount.CustomPricingUnit;
-
-              /**
-               * The monetary amount of the credit grant. Required if `type` is `monetary`.
-               */
-              monetary?: V2.Amount;
-            }
-
-            namespace Amount {
-              interface CustomPricingUnit {
-                /**
-                 * The Custom Pricing Unit object.
-                 */
-                custom_pricing_unit_details?: Stripe.V2.Billing.CustomPricingUnit;
-
-                /**
-                 * The id of the custom pricing unit.
-                 */
-                id: string;
-
-                /**
-                 * The value of the credit grant, decimal value represented as a string.
-                 */
-                value: string;
-              }
-
-              type Type = 'custom_pricing_unit' | 'monetary';
-            }
-
-            interface ApplicabilityConfig {
-              /**
-               * The applicability scope of the credit grant.
-               */
-              scope: ApplicabilityConfig.Scope;
-            }
-
-            namespace ApplicabilityConfig {
-              interface Scope {
-                /**
-                 * The billable items to apply the credit grant to.
-                 */
-                billable_items?: Array<string>;
-
-                /**
-                 * The price type that credit grants can apply to. We currently only support the `metered` price type. This will apply to metered prices and rate cards. Cannot be used in combination with `billable_items`.
-                 */
-                price_type?: 'metered';
-              }
-            }
-
-            type Category = 'paid' | 'promotional';
-
-            interface ExpiryConfig {
-              /**
-               * The type of the expiry configuration. We currently support `end_of_service_period`.
-               */
-              type: 'end_of_service_period';
-            }
-          }
-
-          type ServiceInterval = 'day' | 'month' | 'week' | 'year';
-
-          type Type = 'credit_grant' | 'credit_grant_per_tenant';
-        }
-      }
-    }
-  }
-}