stripe 16.13.0-beta.1 → 17.0.0

package/types/Billing/CreditBalanceSummaryResource.d.ts

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface CreditBalanceSummaryRetrieveParams {
+        /**
+         * The customer for which to fetch credit balance summary.
+         */
+        customer: string;
+
+        /**
+         * The filter criteria for the credit balance summary.
+         */
+        filter: CreditBalanceSummaryRetrieveParams.Filter;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace CreditBalanceSummaryRetrieveParams {
+        interface Filter {
+          /**
+           * The credit applicability scope for which to fetch balance summary.
+           */
+          applicability_scope?: Filter.ApplicabilityScope;
+
+          /**
+           * The credit grant for which to fetch balance summary.
+           */
+          credit_grant?: string;
+
+          /**
+           * Specify the type of this filter.
+           */
+          type: Filter.Type;
+        }
+
+        namespace Filter {
+          interface ApplicabilityScope {
+            /**
+             * The price type to which credit grants can apply to. We currently only support `metered` price type.
+             */
+            price_type: 'metered';
+          }
+
+          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,159 @@
+// 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 balance transaction. Only present if type is `credit`.
+         */
+        credit: CreditBalanceTransaction.Credit | null;
+
+        /**
+         * The credit grant associated with this balance transaction.
+         */
+        credit_grant: string | Stripe.Billing.CreditGrant;
+
+        /**
+         * Debit details for this balance transaction. Only present if type is `debit`.
+         */
+        debit: CreditBalanceTransaction.Debit | null;
+
+        /**
+         * The effective time of this balance transaction.
+         */
+        effective_at: number;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * ID of the test clock this credit balance transaction belongs to.
+         */
+        test_clock: string | Stripe.TestHelpers.TestClock | null;
+
+        /**
+         * The type of balance transaction (credit or debit).
+         */
+        type: CreditBalanceTransaction.Type | null;
+      }
+
+      namespace CreditBalanceTransaction {
+        interface Credit {
+          amount: Credit.Amount;
+
+          /**
+           * The type of credit transaction.
+           */
+          type: 'credits_granted';
+        }
+
+        namespace Credit {
+          interface Amount {
+            /**
+             * The monetary amount.
+             */
+            monetary: Amount.Monetary | null;
+
+            /**
+             * The type of this amount. We currently only support `monetary` 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 Debit {
+          amount: Debit.Amount;
+
+          /**
+           * Details of how the 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` 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 credits were applied.
+             */
+            invoice: string | Stripe.Invoice;
+
+            /**
+             * The invoice line item to which the 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,54 @@
+// 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 customer for which to fetch credit balance transactions.
+         */
+        customer: string;
+
+        /**
+         * The credit grant for which to fetch credit balance transactions.
+         */
+        credit_grant?: 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>;
+      }
+    }
+  }
+}

package/types/Billing/CreditGrants.d.ts

@@ -0,0 +1,124 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * A credit grant is a resource that records a grant of some credit to a customer.
+       */
+      interface CreditGrant {
+        /**
+         * 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_grant';
+
+        amount: CreditGrant.Amount;
+
+        applicability_config: CreditGrant.ApplicabilityConfig;
+
+        /**
+         * The category of this credit grant.
+         */
+        category: CreditGrant.Category;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Id of the customer to whom the credit was granted.
+         */
+        customer: string | Stripe.Customer | Stripe.DeletedCustomer;
+
+        /**
+         * The time when the credit becomes effective i.e when it is eligible to be used.
+         */
+        effective_at: number | null;
+
+        /**
+         * The time when the credit will expire. If not present, the credit will never expire.
+         */
+        expires_at: number | 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://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;
+
+        /**
+         * A descriptive name shown in dashboard and on invoices.
+         */
+        name: string | null;
+
+        /**
+         * ID of the test clock this credit grant belongs to.
+         */
+        test_clock: string | Stripe.TestHelpers.TestClock | null;
+
+        /**
+         * Time at which the object was last updated. Measured in seconds since the Unix epoch.
+         */
+        updated: number;
+
+        /**
+         * The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
+         */
+        voided_at: number | null;
+      }
+
+      namespace CreditGrant {
+        interface Amount {
+          /**
+           * The monetary amount.
+           */
+          monetary: Amount.Monetary | null;
+
+          /**
+           * The type of this amount. We currently only support `monetary` 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 ApplicabilityConfig {
+          scope: ApplicabilityConfig.Scope;
+        }
+
+        namespace ApplicabilityConfig {
+          interface Scope {
+            /**
+             * The price type to which credit grants can apply to. We currently only support `metered` price type.
+             */
+            price_type: 'metered';
+          }
+        }
+
+        type Category = 'paid' | 'promotional';
+      }
+    }
+  }
+}

package/types/Billing/CreditGrantsResource.d.ts

@@ -0,0 +1,219 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface CreditGrantCreateParams {
+        /**
+         * Amount of this credit grant.
+         */
+        amount: CreditGrantCreateParams.Amount;
+
+        /**
+         * Configuration specifying what this credit grant applies to.
+         */
+        applicability_config: CreditGrantCreateParams.ApplicabilityConfig;
+
+        /**
+         * The category of this credit grant.
+         */
+        category: CreditGrantCreateParams.Category;
+
+        /**
+         * Id of the customer to whom the credit should be granted.
+         */
+        customer: string;
+
+        /**
+         * The time when the credit becomes effective i.e when it is eligible to be used. Defaults to the current timestamp if not specified.
+         */
+        effective_at?: number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The time when the credit will expire. If not specified, the credit will never expire.
+         */
+        expires_at?: number;
+
+        /**
+         * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (ex: cost basis) in a structured format.
+         */
+        metadata?: Stripe.MetadataParam;
+
+        /**
+         * A descriptive name shown in dashboard and on invoices.
+         */
+        name?: string;
+      }
+
+      namespace CreditGrantCreateParams {
+        interface Amount {
+          /**
+           * The monetary amount.
+           */
+          monetary?: Amount.Monetary;
+
+          /**
+           * Specify the type of this amount. We currently only support `monetary` credits.
+           */
+          type: 'monetary';
+        }
+
+        namespace Amount {
+          interface Monetary {
+            /**
+             * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
+             */
+            currency: string;
+
+            /**
+             * A positive integer representing the amount of the credit grant.
+             */
+            value: number;
+          }
+        }
+
+        interface ApplicabilityConfig {
+          /**
+           * Specify the scope of this applicability config.
+           */
+          scope: ApplicabilityConfig.Scope;
+        }
+
+        namespace ApplicabilityConfig {
+          interface Scope {
+            /**
+             * The price type to which credit grants can apply to. We currently only support `metered` price type.
+             */
+            price_type: 'metered';
+          }
+        }
+
+        type Category = 'paid' | 'promotional';
+      }
+
+      interface CreditGrantRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditGrantUpdateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The time when the credit created by this credit grant will expire. If set to empty, the credit will never expire.
+         */
+        expires_at?: Stripe.Emptyable<number>;
+
+        /**
+         * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (ex: cost basis) in a structured format.
+         */
+        metadata?: Stripe.MetadataParam;
+      }
+
+      interface CreditGrantListParams extends PaginationParams {
+        /**
+         * Only return credit grants for this customer.
+         */
+        customer?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditGrantExpireParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditGrantVoidGrantParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class CreditGrantsResource {
+        /**
+         * Creates a credit grant
+         */
+        create(
+          params: CreditGrantCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Retrieves a credit grant
+         */
+        retrieve(
+          id: string,
+          params?: CreditGrantRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Updates a credit grant
+         */
+        update(
+          id: string,
+          params?: CreditGrantUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Retrieve a list of credit grants
+         */
+        list(
+          params?: CreditGrantListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditGrant>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditGrant>;
+
+        /**
+         * Expires a credit grant
+         */
+        expire(
+          id: string,
+          params?: CreditGrantExpireParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+        expire(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Voids a credit grant
+         */
+        voidGrant(
+          id: string,
+          params?: CreditGrantVoidGrantParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+        voidGrant(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+      }
+    }
+  }
+}

package/types/BillingPortal/ConfigurationsResource.d.ts

@@ -178,7 +178,7 @@ declare module 'stripe' {
             /**
              * The types of subscription updates that are supported. When empty, subscriptions are not updateable.
              */
-            default_allowed_updates: Stripe.Emptyable<
+            default_allowed_updates?: Stripe.Emptyable<
               Array<SubscriptionUpdate.DefaultAllowedUpdate>
             >;
 
@@ -190,7 +190,7 @@ declare module 'stripe' {
             /**
              * The list of up to 10 products that support subscription updates.
              */
-            products: Stripe.Emptyable<Array<SubscriptionUpdate.Product>>;
+            products?: Stripe.Emptyable<Array<SubscriptionUpdate.Product>>;
 
             /**
              * Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.

package/types/Capabilities.d.ts

@@ -38,7 +38,7 @@ declare module 'stripe' {
       requirements?: Capability.Requirements;
 
       /**
-       * The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`.
+       * The status of the capability.
        */
       status: Capability.Status;
     }