@depup/stripe 21.0.0-depup.0

package/types/Billing/AlertsResource.d.ts

@@ -0,0 +1,183 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface AlertCreateParams {
+        /**
+         * The type of alert to create.
+         */
+        alert_type: 'usage_threshold';
+
+        /**
+         * The title of the alert.
+         */
+        title: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The configuration of the usage threshold.
+         */
+        usage_threshold?: AlertCreateParams.UsageThreshold;
+      }
+
+      namespace AlertCreateParams {
+        interface UsageThreshold {
+          /**
+           * The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
+           */
+          filters?: Array<UsageThreshold.Filter>;
+
+          /**
+           * Defines the threshold value that triggers the alert.
+           */
+          gte: number;
+
+          /**
+           * The [Billing Meter](https://docs.stripe.com/api/billing/meter) ID whose usage is monitored.
+           */
+          meter: string;
+
+          /**
+           * Defines how the alert will behave.
+           */
+          recurrence: 'one_time';
+        }
+
+        namespace UsageThreshold {
+          interface Filter {
+            /**
+             * Limit the scope to this usage alert only to this customer.
+             */
+            customer?: string;
+
+            /**
+             * What type of filter is being applied to this usage alert.
+             */
+            type: 'customer';
+          }
+        }
+      }
+
+      interface AlertRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AlertListParams extends PaginationParams {
+        /**
+         * Filter results to only include this type of alert.
+         */
+        alert_type?: 'usage_threshold';
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Filter results to only include alerts with the given meter.
+         */
+        meter?: string;
+      }
+
+      interface AlertActivateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AlertArchiveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AlertDeactivateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class AlertsResource {
+        /**
+         * Creates a billing alert
+         */
+        create(
+          params: AlertCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Retrieves a billing alert given an ID
+         */
+        retrieve(
+          id: string,
+          params?: AlertRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Lists billing active and inactive alerts
+         */
+        list(
+          params?: AlertListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.Alert>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Billing.Alert>;
+
+        /**
+         * Reactivates this alert, allowing it to trigger again.
+         */
+        activate(
+          id: string,
+          params?: AlertActivateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        activate(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Archives this alert, removing it from the list view and APIs. This is non-reversible.
+         */
+        archive(
+          id: string,
+          params?: AlertArchiveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        archive(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Deactivates this alert, preventing it from triggering.
+         */
+        deactivate(
+          id: string,
+          params?: AlertDeactivateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        deactivate(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+      }
+    }
+  }
+}

package/types/Billing/CreditBalanceSummary.d.ts

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * Indicates the billing credit balance for billing credits granted to a customer.
+       */
+      interface CreditBalanceSummary {
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing.credit_balance_summary';
+
+        /**
+         * The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
+         */
+        balances: Array<CreditBalanceSummary.Balance>;
+
+        /**
+         * The customer the balance is for.
+         */
+        customer: string | Stripe.Customer | Stripe.DeletedCustomer;
+
+        /**
+         * The account the balance is for.
+         */
+        customer_account: string | 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;
+      }
+
+      namespace CreditBalanceSummary {
+        interface Balance {
+          available_balance: Balance.AvailableBalance;
+
+          ledger_balance: Balance.LedgerBalance;
+        }
+
+        namespace Balance {
+          interface AvailableBalance {
+            /**
+             * The monetary amount.
+             */
+            monetary: AvailableBalance.Monetary | null;
+
+            /**
+             * The type of this amount. We currently only support `monetary` billing credits.
+             */
+            type: 'monetary';
+          }
+
+          namespace AvailableBalance {
+            interface Monetary {
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+
+          interface LedgerBalance {
+            /**
+             * The monetary amount.
+             */
+            monetary: LedgerBalance.Monetary | null;
+
+            /**
+             * The type of this amount. We currently only support `monetary` billing credits.
+             */
+            type: 'monetary';
+          }
+
+          namespace LedgerBalance {
+            interface Monetary {
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/Billing/CreditBalanceSummaryResource.d.ts

@@ -0,0 +1,83 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface CreditBalanceSummaryRetrieveParams {
+        /**
+         * The filter criteria for the credit balance summary.
+         */
+        filter: CreditBalanceSummaryRetrieveParams.Filter;
+
+        /**
+         * The customer whose credit balance summary you're retrieving.
+         */
+        customer?: string;
+
+        /**
+         * The account representing the customer whose credit balance summary you're retrieving.
+         */
+        customer_account?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace CreditBalanceSummaryRetrieveParams {
+        interface Filter {
+          /**
+           * The billing credit applicability scope for which to fetch credit balance summary.
+           */
+          applicability_scope?: Filter.ApplicabilityScope;
+
+          /**
+           * The credit grant for which to fetch credit balance summary.
+           */
+          credit_grant?: string;
+
+          /**
+           * Specify the type of this filter.
+           */
+          type: Filter.Type;
+        }
+
+        namespace Filter {
+          interface ApplicabilityScope {
+            /**
+             * The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
+             */
+            price_type?: 'metered';
+
+            /**
+             * A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
+             */
+            prices?: Array<ApplicabilityScope.Price>;
+          }
+
+          namespace ApplicabilityScope {
+            interface Price {
+              /**
+               * The price ID this credit grant should apply to.
+               */
+              id: string;
+            }
+          }
+
+          type Type = 'applicability_scope' | 'credit_grant';
+        }
+      }
+
+      class CreditBalanceSummaryResource {
+        /**
+         * Retrieves the credit balance summary for a customer.
+         */
+        retrieve(
+          params: CreditBalanceSummaryRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditBalanceSummary>>;
+      }
+    }
+  }
+}

package/types/Billing/CreditBalanceTransactions.d.ts

@@ -0,0 +1,178 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
+       */
+      interface CreditBalanceTransaction {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing.credit_balance_transaction';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Credit details for this credit balance transaction. Only present if type is `credit`.
+         */
+        credit: CreditBalanceTransaction.Credit | null;
+
+        /**
+         * The credit grant associated with this credit balance transaction.
+         */
+        credit_grant: string | Stripe.Billing.CreditGrant;
+
+        /**
+         * Debit details for this credit balance transaction. Only present if type is `debit`.
+         */
+        debit: CreditBalanceTransaction.Debit | null;
+
+        /**
+         * The effective time of this credit balance transaction.
+         */
+        effective_at: number;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * ID of the test clock this credit balance transaction belongs to.
+         */
+        test_clock: string | Stripe.TestHelpers.TestClock | null;
+
+        /**
+         * The type of credit balance transaction (credit or debit).
+         */
+        type: CreditBalanceTransaction.Type | null;
+      }
+
+      namespace CreditBalanceTransaction {
+        interface Credit {
+          amount: Credit.Amount;
+
+          /**
+           * Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.
+           */
+          credits_application_invoice_voided: Credit.CreditsApplicationInvoiceVoided | null;
+
+          /**
+           * The type of credit transaction.
+           */
+          type: Credit.Type;
+        }
+
+        namespace Credit {
+          interface Amount {
+            /**
+             * The monetary amount.
+             */
+            monetary: Amount.Monetary | null;
+
+            /**
+             * The type of this amount. We currently only support `monetary` billing credits.
+             */
+            type: 'monetary';
+          }
+
+          namespace Amount {
+            interface Monetary {
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+
+          interface CreditsApplicationInvoiceVoided {
+            /**
+             * The invoice to which the reinstated billing credits were originally applied.
+             */
+            invoice: string | Stripe.Invoice;
+
+            /**
+             * The invoice line item to which the reinstated billing credits were originally applied.
+             */
+            invoice_line_item: string;
+          }
+
+          type Type = 'credits_application_invoice_voided' | 'credits_granted';
+        }
+
+        interface Debit {
+          amount: Debit.Amount;
+
+          /**
+           * Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.
+           */
+          credits_applied: Debit.CreditsApplied | null;
+
+          /**
+           * The type of debit transaction.
+           */
+          type: Debit.Type;
+        }
+
+        namespace Debit {
+          interface Amount {
+            /**
+             * The monetary amount.
+             */
+            monetary: Amount.Monetary | null;
+
+            /**
+             * The type of this amount. We currently only support `monetary` billing credits.
+             */
+            type: 'monetary';
+          }
+
+          namespace Amount {
+            interface Monetary {
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+
+          interface CreditsApplied {
+            /**
+             * The invoice to which the billing credits were applied.
+             */
+            invoice: string | Stripe.Invoice;
+
+            /**
+             * The invoice line item to which the billing credits were applied.
+             */
+            invoice_line_item: string;
+          }
+
+          type Type = 'credits_applied' | 'credits_expired' | 'credits_voided';
+        }
+
+        type Type = 'credit' | 'debit';
+      }
+    }
+  }
+}

package/types/Billing/CreditBalanceTransactionsResource.d.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface CreditBalanceTransactionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditBalanceTransactionListParams extends PaginationParams {
+        /**
+         * The credit grant for which to fetch credit balance transactions.
+         */
+        credit_grant?: string;
+
+        /**
+         * The customer whose credit balance transactions you're retrieving.
+         */
+        customer?: string;
+
+        /**
+         * The account representing the customer whose credit balance transactions you're retrieving.
+         */
+        customer_account?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class CreditBalanceTransactionsResource {
+        /**
+         * Retrieves a credit balance transaction.
+         */
+        retrieve(
+          id: string,
+          params?: CreditBalanceTransactionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditBalanceTransaction>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditBalanceTransaction>>;
+
+        /**
+         * Retrieve a list of credit balance transactions.
+         */
+        list(
+          params?: CreditBalanceTransactionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditBalanceTransaction>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditBalanceTransaction>;
+      }
+    }
+  }
+}