stripe 19.2.1 → 19.3.0-alpha.2

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

@@ -0,0 +1,203 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        namespace RateCards {
+          interface RateCreateParams {
+            /**
+             * The custom pricing unit that this rate binds to.
+             */
+            custom_pricing_unit_amount?: RateCreateParams.CustomPricingUnitAmount;
+
+            /**
+             * 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;
+
+            /**
+             * The Metered Item that this rate binds to.
+             */
+            metered_item?: string;
+
+            /**
+             * Defines whether the tiered price should be 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?: RateCreateParams.TieringMode;
+
+            /**
+             * Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+             */
+            tiers?: Array<RateCreateParams.Tier>;
+
+            /**
+             * Apply a transformation to the reported usage or set quantity before computing the amount billed.
+             */
+            transform_quantity?: RateCreateParams.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;
+          }
+
+          namespace RateCreateParams {
+            interface CustomPricingUnitAmount {
+              /**
+               * The id of the custom pricing unit.
+               */
+              id: string;
+
+              /**
+               * The unit value for the custom pricing unit, as a string.
+               */
+              value: string;
+            }
+
+            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 will be contained in the tier. Only one of `up_to_decimal` and `up_to_inf` may
+               * be set.
+               */
+              up_to_decimal?: string;
+
+              /**
+               * No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+               */
+              up_to_inf?: 'inf';
+            }
+
+            type TieringMode = 'graduated' | 'volume';
+
+            interface TransformQuantity {
+              /**
+               * Divide usage by this number.
+               */
+              divide_by: number;
+
+              /**
+               * After division, round the result up or down.
+               */
+              round: TransformQuantity.Round;
+            }
+
+            namespace TransformQuantity {
+              type Round = 'down' | 'up';
+            }
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace RateCards {
+          interface RateRetrieveParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace RateCards {
+          interface RateListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 20.
+             */
+            limit?: number;
+
+            /**
+             * Optionally filter by a Metered Item.
+             */
+            metered_item?: string;
+
+            /**
+             * Optionally filter by a RateCard version. If not specified, defaults to the latest version.
+             */
+            rate_card_version?: string;
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace RateCards {
+          interface RateDeleteParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace RateCards {
+          class RatesResource {
+            /**
+             * Set the Rate for a Metered Item on the latest version of a Rate Card object. This will create a new Rate Card version
+             * if the Metered Item already has a rate on the Rate Card.
+             */
+            create(
+              id: string,
+              params?: RateCreateParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardRate>>;
+            create(
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardRate>>;
+
+            /**
+             * Retrieve a Rate object.
+             */
+            retrieve(
+              rateCardId: string,
+              id: string,
+              params?: RateRetrieveParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardRate>>;
+            retrieve(
+              rateCardId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardRate>>;
+
+            /**
+             * List all Rates associated with a Rate Card for a specific version (defaults to latest). Rates remain active for all subsequent versions until a new rate is created for the same Metered Item.
+             */
+            list(
+              id: string,
+              params?: RateListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.RateCardRate>;
+            list(
+              id: string,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.RateCardRate>;
+
+            /**
+             * Remove an existing Rate from a Rate Card. This will create a new Rate Card Version without that Rate.
+             */
+            del(
+              rateCardId: string,
+              id: string,
+              params?: RateDeleteParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
+            del(
+              rateCardId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,58 @@
+// 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

@@ -0,0 +1,98 @@
+// 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

@@ -0,0 +1,162 @@
+// 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>;
+        }
+      }
+    }
+  }
+}