@depup/stripe 21.0.0-depup.0

package/types/Billing/Meters.d.ts

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
+       *
+       * Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
+       */
+      interface Meter {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing.meter';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        customer_mapping: Meter.CustomerMapping;
+
+        default_aggregation: Meter.DefaultAggregation;
+
+        /**
+         * The meter's name.
+         */
+        display_name: string;
+
+        /**
+         * The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
+         */
+        event_name: string;
+
+        /**
+         * The time window which meter events have been pre-aggregated for, if any.
+         */
+        event_time_window: Meter.EventTimeWindow | null;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * The meter's status.
+         */
+        status: Meter.Status;
+
+        status_transitions: Meter.StatusTransitions;
+
+        /**
+         * Time at which the object was last updated. Measured in seconds since the Unix epoch.
+         */
+        updated: number;
+
+        value_settings: Meter.ValueSettings;
+      }
+
+      namespace Meter {
+        interface CustomerMapping {
+          /**
+           * The key in the meter event payload to use for mapping the event to a customer.
+           */
+          event_payload_key: string;
+
+          /**
+           * The method for mapping a meter event to a customer.
+           */
+          type: 'by_id';
+        }
+
+        interface DefaultAggregation {
+          /**
+           * Specifies how events are aggregated.
+           */
+          formula: DefaultAggregation.Formula;
+        }
+
+        namespace DefaultAggregation {
+          type Formula = 'count' | 'last' | 'sum';
+        }
+
+        type EventTimeWindow = 'day' | 'hour';
+
+        type Status = 'active' | 'inactive';
+
+        interface StatusTransitions {
+          /**
+           * The time the meter was deactivated, if any. Measured in seconds since Unix epoch.
+           */
+          deactivated_at: number | null;
+        }
+
+        interface ValueSettings {
+          /**
+           * The key in the meter event payload to use as the value for this meter.
+           */
+          event_payload_key: string;
+        }
+      }
+    }
+  }
+}

package/types/Billing/MetersResource.d.ts

@@ -0,0 +1,234 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface MeterCreateParams {
+        /**
+         * The default settings to aggregate a meter's events with.
+         */
+        default_aggregation: MeterCreateParams.DefaultAggregation;
+
+        /**
+         * The meter's name. Not visible to the customer.
+         */
+        display_name: string;
+
+        /**
+         * The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
+         */
+        event_name: string;
+
+        /**
+         * Fields that specify how to map a meter event to a customer.
+         */
+        customer_mapping?: MeterCreateParams.CustomerMapping;
+
+        /**
+         * The time window which meter events have been pre-aggregated for, if any.
+         */
+        event_time_window?: MeterCreateParams.EventTimeWindow;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Fields that specify how to calculate a meter event's value.
+         */
+        value_settings?: MeterCreateParams.ValueSettings;
+      }
+
+      namespace MeterCreateParams {
+        interface CustomerMapping {
+          /**
+           * The key in the meter event payload to use for mapping the event to a customer.
+           */
+          event_payload_key: string;
+
+          /**
+           * The method for mapping a meter event to a customer. Must be `by_id`.
+           */
+          type: 'by_id';
+        }
+
+        interface DefaultAggregation {
+          /**
+           * Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value and `last` to take the last event's value in the window.
+           */
+          formula: DefaultAggregation.Formula;
+        }
+
+        namespace DefaultAggregation {
+          type Formula = 'count' | 'last' | 'sum';
+        }
+
+        type EventTimeWindow = 'day' | 'hour';
+
+        interface ValueSettings {
+          /**
+           * The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytes_used` field, then set the event_payload_key to "bytes_used".
+           */
+          event_payload_key: string;
+        }
+      }
+
+      interface MeterRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface MeterUpdateParams {
+        /**
+         * The meter's name. Not visible to the customer.
+         */
+        display_name?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface MeterListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Filter results to only include meters with the given status.
+         */
+        status?: MeterListParams.Status;
+      }
+
+      namespace MeterListParams {
+        type Status = 'active' | 'inactive';
+      }
+
+      interface MeterDeactivateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface MeterListEventSummariesParams extends PaginationParams {
+        /**
+         * The customer for which to fetch event summaries.
+         */
+        customer: string;
+
+        /**
+         * The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
+         */
+        end_time: number;
+
+        /**
+         * The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
+         */
+        start_time: number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).
+         */
+        value_grouping_window?: MeterListEventSummariesParams.ValueGroupingWindow;
+      }
+
+      namespace MeterListEventSummariesParams {
+        type ValueGroupingWindow = 'day' | 'hour';
+      }
+
+      interface MeterReactivateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class MetersResource {
+        /**
+         * Creates a billing meter.
+         */
+        create(
+          params: MeterCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+
+        /**
+         * Retrieves a billing meter given an ID.
+         */
+        retrieve(
+          id: string,
+          params?: MeterRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+
+        /**
+         * Updates a billing meter.
+         */
+        update(
+          id: string,
+          params?: MeterUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+
+        /**
+         * Retrieve a list of billing meters.
+         */
+        list(
+          params?: MeterListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.Meter>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Billing.Meter>;
+
+        /**
+         * When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
+         */
+        deactivate(
+          id: string,
+          params?: MeterDeactivateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+        deactivate(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+
+        /**
+         * Retrieve a list of billing meter event summaries.
+         */
+        listEventSummaries(
+          id: string,
+          params: MeterListEventSummariesParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.MeterEventSummary>;
+
+        /**
+         * When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
+         */
+        reactivate(
+          id: string,
+          params?: MeterReactivateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+        reactivate(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
+      }
+    }
+  }
+}

package/types/BillingPortal/Configurations.d.ts

@@ -0,0 +1,319 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace BillingPortal {
+      /**
+       * A portal configuration describes the functionality and behavior you embed in a portal session. Related guide: [Configure the customer portal](https://docs.stripe.com/customer-management/configure-portal).
+       */
+      interface Configuration {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing_portal.configuration';
+
+        /**
+         * Whether the configuration is active and can be used to create portal sessions.
+         */
+        active: boolean;
+
+        /**
+         * ID of the Connect Application that created the configuration.
+         */
+        application:
+          | string
+          | Stripe.Application
+          | Stripe.DeletedApplication
+          | null;
+
+        business_profile: Configuration.BusinessProfile;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
+         */
+        default_return_url: string | null;
+
+        features: Configuration.Features;
+
+        /**
+         * Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
+         */
+        is_default: boolean;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        login_page: Configuration.LoginPage;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/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 name of the configuration.
+         */
+        name: string | null;
+
+        /**
+         * Time at which the object was last updated. Measured in seconds since the Unix epoch.
+         */
+        updated: number;
+      }
+
+      namespace Configuration {
+        interface BusinessProfile {
+          /**
+           * The messaging shown to customers in the portal.
+           */
+          headline: string | null;
+
+          /**
+           * A link to the business's publicly available privacy policy.
+           */
+          privacy_policy_url: string | null;
+
+          /**
+           * A link to the business's publicly available terms of service.
+           */
+          terms_of_service_url: string | null;
+        }
+
+        interface Features {
+          customer_update: Features.CustomerUpdate;
+
+          invoice_history: Features.InvoiceHistory;
+
+          payment_method_update: Features.PaymentMethodUpdate;
+
+          subscription_cancel: Features.SubscriptionCancel;
+
+          subscription_update: Features.SubscriptionUpdate;
+        }
+
+        namespace Features {
+          interface CustomerUpdate {
+            /**
+             * The types of customer updates that are supported. When empty, customers are not updateable.
+             */
+            allowed_updates: Array<CustomerUpdate.AllowedUpdate>;
+
+            /**
+             * Whether the feature is enabled.
+             */
+            enabled: boolean;
+          }
+
+          namespace CustomerUpdate {
+            type AllowedUpdate =
+              | 'address'
+              | 'email'
+              | 'name'
+              | 'phone'
+              | 'shipping'
+              | 'tax_id';
+          }
+
+          interface InvoiceHistory {
+            /**
+             * Whether the feature is enabled.
+             */
+            enabled: boolean;
+          }
+
+          interface PaymentMethodUpdate {
+            /**
+             * Whether the feature is enabled.
+             */
+            enabled: boolean;
+
+            /**
+             * The [Payment Method Configuration](https://docs.stripe.com/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
+             */
+            payment_method_configuration: string | null;
+          }
+
+          interface SubscriptionCancel {
+            cancellation_reason: SubscriptionCancel.CancellationReason;
+
+            /**
+             * Whether the feature is enabled.
+             */
+            enabled: boolean;
+
+            /**
+             * Whether to cancel subscriptions immediately or at the end of the billing period.
+             */
+            mode: SubscriptionCancel.Mode;
+
+            /**
+             * Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.
+             */
+            proration_behavior: SubscriptionCancel.ProrationBehavior;
+          }
+
+          namespace SubscriptionCancel {
+            interface CancellationReason {
+              /**
+               * Whether the feature is enabled.
+               */
+              enabled: boolean;
+
+              /**
+               * Which cancellation reasons will be given as options to the customer.
+               */
+              options: Array<CancellationReason.Option>;
+            }
+
+            namespace CancellationReason {
+              type Option =
+                | 'customer_service'
+                | 'low_quality'
+                | 'missing_features'
+                | 'other'
+                | 'switched_service'
+                | 'too_complex'
+                | 'too_expensive'
+                | 'unused';
+            }
+
+            type Mode = 'at_period_end' | 'immediately';
+
+            type ProrationBehavior =
+              | 'always_invoice'
+              | 'create_prorations'
+              | 'none';
+          }
+
+          interface SubscriptionUpdate {
+            /**
+             * Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
+             */
+            billing_cycle_anchor: SubscriptionUpdate.BillingCycleAnchor | null;
+
+            /**
+             * The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
+             */
+            default_allowed_updates: Array<
+              SubscriptionUpdate.DefaultAllowedUpdate
+            >;
+
+            /**
+             * Whether the feature is enabled.
+             */
+            enabled: boolean;
+
+            /**
+             * The list of up to 10 products that support subscription updates.
+             */
+            products?: Array<SubscriptionUpdate.Product> | null;
+
+            /**
+             * Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.
+             */
+            proration_behavior: SubscriptionUpdate.ProrationBehavior;
+
+            schedule_at_period_end: SubscriptionUpdate.ScheduleAtPeriodEnd;
+
+            /**
+             * Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation.
+             */
+            trial_update_behavior: SubscriptionUpdate.TrialUpdateBehavior;
+          }
+
+          namespace SubscriptionUpdate {
+            type BillingCycleAnchor = 'now' | 'unchanged';
+
+            type DefaultAllowedUpdate = 'price' | 'promotion_code' | 'quantity';
+
+            interface Product {
+              adjustable_quantity: Product.AdjustableQuantity;
+
+              /**
+               * The list of price IDs which, when subscribed to, a subscription can be updated.
+               */
+              prices: Array<string>;
+
+              /**
+               * The product ID.
+               */
+              product: string;
+            }
+
+            namespace Product {
+              interface AdjustableQuantity {
+                /**
+                 * If true, the quantity can be adjusted to any non-negative integer.
+                 */
+                enabled: boolean;
+
+                /**
+                 * The maximum quantity that can be set for the product.
+                 */
+                maximum: number | null;
+
+                /**
+                 * The minimum quantity that can be set for the product.
+                 */
+                minimum: number;
+              }
+            }
+
+            type ProrationBehavior =
+              | 'always_invoice'
+              | 'create_prorations'
+              | 'none';
+
+            interface ScheduleAtPeriodEnd {
+              /**
+               * List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
+               */
+              conditions: Array<ScheduleAtPeriodEnd.Condition>;
+            }
+
+            namespace ScheduleAtPeriodEnd {
+              interface Condition {
+                /**
+                 * The type of condition.
+                 */
+                type: Condition.Type;
+              }
+
+              namespace Condition {
+                type Type = 'decreasing_item_amount' | 'shortening_interval';
+              }
+            }
+
+            type TrialUpdateBehavior = 'continue_trial' | 'end_trial';
+          }
+        }
+
+        interface LoginPage {
+          /**
+           * If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.
+           *
+           * If `false`, the previously generated `url`, if any, will be deactivated.
+           */
+          enabled: boolean;
+
+          /**
+           * A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal.
+           */
+          url: string | null;
+        }
+      }
+    }
+  }
+}