stripe 18.5.0 → 18.6.0-alpha.1

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

@@ -0,0 +1,138 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The RateCardRate object.
+         */
+        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: RateCardRate.CustomPricingUnitAmount | null;
+
+          /**
+           * 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: Stripe.Metadata | null;
+
+          /**
+           * The Metered Item that this rate binds to.
+           */
+          metered_item: Stripe.V2.Billing.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 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: RateCardRate.TieringMode | null;
+
+          /**
+           * Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+           */
+          tiers: Array<RateCardRate.Tier>;
+
+          /**
+           * Apply a transformation to the reported usage or set quantity before computing the amount billed.
+           */
+          transform_quantity: RateCardRate.TransformQuantity | null;
+
+          /**
+           * 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 | null;
+        }
+
+        namespace RateCardRate {
+          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 | null;
+
+            /**
+             * 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 | null;
+
+            /**
+             * 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 | null;
+
+            /**
+             * No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+             */
+            up_to_inf: 'inf' | null;
+          }
+
+          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';
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,134 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The RateCardSubscription object.
+         */
+        interface RateCardSubscription {
+          /**
+           * 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_subscription';
+
+          /**
+           * The ID of the Billing Cadence.
+           */
+          billing_cadence: string;
+
+          /**
+           * The payment status of a Rate Card Subscription.
+           */
+          collection_status: RateCardSubscription.CollectionStatus | null;
+
+          /**
+           * The collection status transitions of the Rate Card Subscription.
+           */
+          collection_status_transitions: RateCardSubscription.CollectionStatusTransitions | null;
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: 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: Stripe.Metadata | null;
+
+          /**
+           * The ID of the Rate Card.
+           */
+          rate_card: string;
+
+          /**
+           * The ID of the Rate Card Version.
+           */
+          rate_card_version: string;
+
+          /**
+           * The servicing status of a Rate Card Subscription.
+           */
+          servicing_status: RateCardSubscription.ServicingStatus | null;
+
+          /**
+           * The servicing status transitions of the Rate Card Subscription.
+           */
+          servicing_status_transitions: RateCardSubscription.ServicingStatusTransitions | null;
+
+          /**
+           * The ID of the Test Clock, if any.
+           */
+          test_clock: string | null;
+        }
+
+        namespace RateCardSubscription {
+          type CollectionStatus =
+            | 'awaiting_customer_action'
+            | 'current'
+            | 'past_due'
+            | 'paused'
+            | 'unpaid';
+
+          interface CollectionStatusTransitions {
+            /**
+             * When the collection status transitioned to awaiting customer action.
+             */
+            awaiting_customer_action_at: string | null;
+
+            /**
+             * When the collection status transitioned to current.
+             */
+            current_at: string | null;
+
+            /**
+             * When the collection status transitioned to past due.
+             */
+            past_due_at: string | null;
+
+            /**
+             * When the collection status transitioned to paused.
+             */
+            paused_at: string | null;
+
+            /**
+             * When the collection status transitioned to unpaid.
+             */
+            unpaid_at: string | null;
+          }
+
+          type ServicingStatus = 'active' | 'canceled' | 'paused' | 'pending';
+
+          interface ServicingStatusTransitions {
+            /**
+             * When the servicing status transitioned to activated.
+             */
+            activated_at: string | null;
+
+            /**
+             * When the servicing status transitioned to canceled.
+             */
+            canceled_at: string | null;
+
+            /**
+             * When the servicing status transitioned to paused.
+             */
+            paused_at: string | null;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,157 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface RateCardSubscriptionCreateParams {
+          /**
+           * The ID of the Billing Cadence.
+           */
+          billing_cadence: string;
+
+          /**
+           * The ID of the Rate Card.
+           */
+          rate_card: 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;
+
+          /**
+           * The ID of the Rate Card Version. If not specified, defaults to the "live_version" of the Rate Card at the time of creation.
+           */
+          rate_card_version?: string;
+        }
+      }
+
+      namespace Billing {
+        interface RateCardSubscriptionRetrieveParams {}
+      }
+
+      namespace Billing {
+        interface RateCardSubscriptionUpdateParams {
+          /**
+           * 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 RateCardSubscriptionListParams {
+          /**
+           * Optionally filter by a BillingCadence. Mutually exclusive with `payers`, `rate_card`, and `rate_card_version`.
+           */
+          billing_cadence?: string;
+
+          /**
+           * The page size limit, if not provided the default is 20.
+           */
+          limit?: number;
+
+          /**
+           * Optionally filter by the payer associated with Billing Cadences which the Rate Card Subscriptions are subscribed to.
+           * Mutually exclusive with `billing_cadence`, `rate_card`, and `rate_card_version`.
+           */
+          payer?: RateCardSubscriptionListParams.Payer;
+
+          /**
+           * Optionally filter by a RateCard. Mutually exclusive with `billing_cadence`, `payers`, and `rate_card_version`.
+           */
+          rate_card?: string;
+
+          /**
+           * Optionally filter by a RateCard version. Mutually exclusive with `billing_cadence`, `payers`, and `rate_card`.
+           */
+          rate_card_version?: string;
+
+          /**
+           * Optionally filter by servicing status.
+           */
+          servicing_status?: RateCardSubscriptionListParams.ServicingStatus;
+        }
+
+        namespace RateCardSubscriptionListParams {
+          interface Payer {
+            /**
+             * The ID of the Customer object. If provided, only the Rate Card Subscriptions that are subscribed on the Billing Cadences with the specified payer will be returned.
+             */
+            customer?: string;
+
+            /**
+             * A string identifying the type of the payer. Currently the only supported value is `customer`.
+             */
+            type: 'customer';
+          }
+
+          type ServicingStatus = 'active' | 'canceled' | 'paused' | 'pending';
+        }
+      }
+
+      namespace Billing {
+        interface RateCardSubscriptionCancelParams {}
+      }
+
+      namespace Billing {
+        class RateCardSubscriptionsResource {
+          /**
+           * Create a Rate Card Subscription to bill a Rate Card on a specified Billing Cadence.
+           */
+          create(
+            params: RateCardSubscriptionCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardSubscription>>;
+
+          /**
+           * Retrieve a Rate Card Subscription by ID.
+           */
+          retrieve(
+            id: string,
+            params?: RateCardSubscriptionRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardSubscription>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardSubscription>>;
+
+          /**
+           * Update fields on an existing, active Rate Card Subscription.
+           */
+          update(
+            id: string,
+            params?: RateCardSubscriptionUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardSubscription>>;
+
+          /**
+           * List all Rate Card Subscription objects.
+           */
+          list(
+            params?: RateCardSubscriptionListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Billing.RateCardSubscription>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Billing.RateCardSubscription>;
+
+          /**
+           * Cancel an existing, active Rate Card Subscription.
+           */
+          cancel(
+            id: string,
+            params?: RateCardSubscriptionCancelParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardSubscription>>;
+          cancel(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardSubscription>>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The RateCardVersion object.
+         */
+        interface RateCardVersion {
+          /**
+           * 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_version';
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: 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;
+
+          /**
+           * The ID of the Rate Card that this version belongs to.
+           */
+          rate_card_id: string;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,209 @@
+// 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;
+
+            /**
+             * The ID of the price object to take price information from. The price must have the same interval as the rate card.
+             * Updates to the Price will not be reflected in the Rate Card or its rates.
+             */
+            price?: 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.Billing.RateCardRate>>;
+            del(
+              rateCardId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.RateCardRate>>;
+          }
+        }
+      }
+    }
+  }
+}