stripe 19.2.1 → 19.3.0-alpha.2

package/types/Billing/CreditGrantsResource.d.ts

@@ -14,15 +14,20 @@ declare module 'stripe' {
          */
         applicability_config: CreditGrantCreateParams.ApplicabilityConfig;
 
+        /**
+         * The category of this credit grant. It defaults to `paid` if not specified.
+         */
+        category?: CreditGrantCreateParams.Category;
+
         /**
          * ID of the customer to receive the billing credits.
          */
-        customer: string;
+        customer?: string;
 
         /**
-         * The category of this credit grant. It defaults to `paid` if not specified.
+         * ID of the account to receive the billing credits.
          */
-        category?: CreditGrantCreateParams.Category;
+        customer_account?: string;
 
         /**
          * The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
@@ -57,6 +62,11 @@ declare module 'stripe' {
 
       namespace CreditGrantCreateParams {
         interface Amount {
+          /**
+           * The custom pricing unit amount.
+           */
+          custom_pricing_unit?: Amount.CustomPricingUnit;
+
           /**
            * The monetary amount.
            */
@@ -65,10 +75,22 @@ declare module 'stripe' {
           /**
            * The type of this amount. We currently only support `monetary` billing credits.
            */
-          type: 'monetary';
+          type: Amount.Type;
         }
 
         namespace Amount {
+          interface CustomPricingUnit {
+            /**
+             * The ID of the custom pricing unit.
+             */
+            id: string;
+
+            /**
+             * A positive integer representing the amount of the credit grant.
+             */
+            value: string;
+          }
+
           interface Monetary {
             /**
              * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
@@ -80,6 +102,8 @@ declare module 'stripe' {
              */
             value: number;
           }
+
+          type Type = 'custom_pricing_unit' | 'monetary';
         }
 
         interface ApplicabilityConfig {
@@ -91,6 +115,11 @@ declare module 'stripe' {
 
         namespace ApplicabilityConfig {
           interface Scope {
+            /**
+             * A list of billable items that the credit grant can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+             */
+            billable_items?: Array<Scope.BillableItem>;
+
             /**
              * The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
              */
@@ -103,6 +132,13 @@ declare module 'stripe' {
           }
 
           namespace Scope {
+            interface BillableItem {
+              /**
+               * The billable item ID this credit grant should apply to.
+               */
+              id: string;
+            }
+
             interface Price {
               /**
                * The price ID this credit grant should apply to.
@@ -145,6 +181,11 @@ declare module 'stripe' {
          */
         customer?: string;
 
+        /**
+         * Only return credit grants for this account.
+         */
+        customer_account?: string;
+
         /**
          * Specifies which fields in the response should be expanded.
          */

package/types/Billing/MeterEventSummaries.d.ts

@@ -25,6 +25,13 @@ declare module 'stripe' {
          */
         aggregated_value: number;
 
+        /**
+         * Key-value pairs of dimension values for event summaries with grouping on dimensions.
+         */
+        dimensions?: {
+          [key: string]: string;
+        } | null;
+
         /**
          * End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
          */

package/types/Billing/Meters.d.ts

@@ -28,6 +28,11 @@ declare module 'stripe' {
 
         default_aggregation: Meter.DefaultAggregation;
 
+        /**
+         * Set of keys that will be used to group meter events by.
+         */
+        dimension_payload_keys?: Array<string> | null;
+
         /**
          * The meter's name.
          */

package/types/Billing/MetersResource.d.ts

@@ -24,6 +24,11 @@ declare module 'stripe' {
          */
         customer_mapping?: MeterCreateParams.CustomerMapping;
 
+        /**
+         * Set of keys that will be used to group meter events by. Each key must be present in the event payload.
+         */
+        dimension_payload_keys?: Array<string>;
+
         /**
          * The time window which meter events have been pre-aggregated for, if any.
          */
@@ -132,6 +137,18 @@ declare module 'stripe' {
          */
         start_time: number;
 
+        /**
+         * Key-value pairs used to filter meter events by dimension values. If specified, event summaries will be generated with only matching meter events.
+         */
+        dimension_filters?: {
+          [key: string]: string;
+        };
+
+        /**
+         * List of dimension payload keys to group by. If specified, event summaries will be grouped by the given dimension payload key values.
+         */
+        dimension_group_by_keys?: Array<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */

package/types/BillingPortal/Sessions.d.ts

@@ -45,6 +45,11 @@ declare module 'stripe' {
          */
         customer: string;
 
+        /**
+         * The ID of the account for this session.
+         */
+        customer_account?: string | null;
+
         /**
          * Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
          */

package/types/BillingPortal/SessionsResource.d.ts

@@ -4,15 +4,20 @@ declare module 'stripe' {
   namespace Stripe {
     namespace BillingPortal {
       interface SessionCreateParams {
+        /**
+         * The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
+         */
+        configuration?: string;
+
         /**
          * The ID of an existing customer.
          */
-        customer: string;
+        customer?: string;
 
         /**
-         * The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
+         * The ID of an existing account.
          */
-        configuration?: string;
+        customer_account?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -256,7 +261,10 @@ declare module 'stripe' {
          * Creates a session of the customer portal.
          */
         create(
-          params: SessionCreateParams,
+          params?: SessionCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.BillingPortal.Session>>;
+        create(
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.BillingPortal.Session>>;
       }

package/types/Capabilities.d.ts

@@ -174,6 +174,7 @@ declare module 'stripe' {
             | 'invalid_url_website_other'
             | 'invalid_value_other'
             | 'unsupported_business_type'
+            | 'verification_data_not_found'
             | 'verification_directors_mismatch'
             | 'verification_document_address_mismatch'
             | 'verification_document_address_missing'
@@ -360,6 +361,7 @@ declare module 'stripe' {
             | 'invalid_url_website_other'
             | 'invalid_value_other'
             | 'unsupported_business_type'
+            | 'verification_data_not_found'
             | 'verification_directors_mismatch'
             | 'verification_document_address_mismatch'
             | 'verification_document_address_missing'

package/types/Capital/FinancingOffers.d.ts

@@ -0,0 +1,188 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      /**
+       * This is an object representing an offer of financing from
+       * Stripe Capital to a Connect subaccount.
+       */
+      interface FinancingOffer {
+        /**
+         * A unique identifier for the financing object.
+         */
+        id: string;
+
+        /**
+         * The object type: financing_offer.
+         */
+        object: 'capital.financing_offer';
+
+        /**
+         * This is an object representing the terms of an offer of financing from
+         * Stripe Capital to a Connected account. This resource represents
+         * the terms accepted by the Connected account, which may differ from those
+         * offered.
+         */
+        accepted_terms?: FinancingOffer.AcceptedTerms;
+
+        /**
+         * The ID of the merchant associated with this financing object.
+         */
+        account: string;
+
+        /**
+         * The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
+         */
+        charged_off_at?: number;
+
+        /**
+         * Time at which the offer was created. Given in seconds since unix epoch.
+         */
+        created: number;
+
+        /**
+         * Time at which the offer expires. Given in seconds since unix epoch.
+         */
+        expires_after: number;
+
+        /**
+         * The type of financing being offered.
+         */
+        financing_type?: FinancingOffer.FinancingType;
+
+        /**
+         * 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;
+
+        /**
+         * This is an object representing the terms of an offer of financing from
+         * Stripe Capital to a Connected account. This resource represents
+         * both the terms offered to the Connected account.
+         */
+        offered_terms?: FinancingOffer.OfferedTerms;
+
+        /**
+         * Financing product identifier.
+         */
+        product_type?: FinancingOffer.ProductType;
+
+        /**
+         * The ID of the financing offer that replaced this offer.
+         */
+        replacement?: string;
+
+        /**
+         * The ID of the financing offer that this offer is a replacement for.
+         */
+        replacement_for?: string;
+
+        /**
+         * The current status of the offer.
+         */
+        status: FinancingOffer.Status;
+
+        /**
+         * See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
+         */
+        type?: FinancingOffer.Type;
+      }
+
+      namespace FinancingOffer {
+        interface AcceptedTerms {
+          /**
+           * Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+           */
+          advance_amount: number;
+
+          /**
+           * Currency that the financing offer is transacted in. For example, `usd`.
+           */
+          currency: string;
+
+          /**
+           * Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+           */
+          fee_amount: number;
+
+          /**
+           * Populated when the `product_type` of the `financingoffer` is `refill`.
+           * Represents the discount amount on remaining premium for the existing loan at payout time.
+           */
+          previous_financing_fee_discount_amount: number | null;
+
+          /**
+           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
+           */
+          withhold_rate: number;
+        }
+
+        type FinancingType = 'cash_advance' | 'flex_loan';
+
+        interface OfferedTerms {
+          /**
+           * Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+           */
+          advance_amount: number;
+
+          /**
+           * Describes the type of user the offer is being extended to.
+           */
+          campaign_type: OfferedTerms.CampaignType;
+
+          /**
+           * Currency that the financing offer is transacted in. For example, `usd`.
+           */
+          currency: string;
+
+          /**
+           * Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+           */
+          fee_amount: number;
+
+          /**
+           * Populated when the `product_type` of the `financingoffer` is `refill`.
+           * Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
+           * is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
+           * and the remaining fee.
+           */
+          previous_financing_fee_discount_rate: number | null;
+
+          /**
+           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
+           */
+          withhold_rate: number;
+        }
+
+        namespace OfferedTerms {
+          type CampaignType =
+            | 'newly_eligible_user'
+            | 'previously_eligible_user'
+            | 'repeat_user';
+        }
+
+        type ProductType = 'refill' | 'standard';
+
+        type Status =
+          | 'accepted'
+          | 'canceled'
+          | 'completed'
+          | 'delivered'
+          | 'expired'
+          | 'fully_repaid'
+          | 'paid_out'
+          | 'rejected'
+          | 'replaced'
+          | 'undelivered';
+
+        type Type = 'cash_advance' | 'fixed_term_loan' | 'flex_loan';
+      }
+    }
+  }
+}

package/types/Capital/FinancingOffersResource.d.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      interface FinancingOfferRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FinancingOfferListParams extends PaginationParams {
+        /**
+         * limit list to offers belonging to given connected account
+         */
+        connected_account?: string;
+
+        /**
+         * Only return offers that were created during the given date interval.
+         */
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * limit list to offers with given status
+         */
+        status?: FinancingOfferListParams.Status;
+      }
+
+      namespace FinancingOfferListParams {
+        type Status =
+          | 'accepted'
+          | 'canceled'
+          | 'completed'
+          | 'delivered'
+          | 'expired'
+          | 'fully_repaid'
+          | 'paid_out'
+          | 'rejected'
+          | 'revoked'
+          | 'undelivered';
+      }
+
+      interface FinancingOfferMarkDeliveredParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class FinancingOffersResource {
+        /**
+         * Get the details of the financing offer
+         */
+        retrieve(
+          id: string,
+          params?: FinancingOfferRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+
+        /**
+         * Retrieves the financing offers available for Connected accounts that belong to your platform.
+         */
+        list(
+          params?: FinancingOfferListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
+
+        /**
+         * Acknowledges that platform has received and delivered the financing_offer to
+         * the intended merchant recipient.
+         */
+        markDelivered(
+          id: string,
+          params?: FinancingOfferMarkDeliveredParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+        markDelivered(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+      }
+    }
+  }
+}

package/types/Capital/FinancingSummary.d.ts

@@ -0,0 +1,106 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      /**
+       * A financing object describes an account's current financing state. Used by Connect
+       * platforms to read the state of Capital offered to their connected accounts.
+       */
+      interface FinancingSummary {
+        /**
+         * The object type: financing_summary
+         */
+        object: 'capital.financing_summary';
+
+        /**
+         * Additional information about the financing summary. Describes currency, advance amount,
+         * fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
+         * repayment start date, and advance payout date.
+         */
+        details: FinancingSummary.Details | null;
+
+        /**
+         * The Financing Offer ID this Financing Summary corresponds to
+         */
+        financing_offer: string | null;
+
+        /**
+         * Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
+         */
+        status: FinancingSummary.Status | null;
+      }
+
+      namespace FinancingSummary {
+        interface Details {
+          /**
+           * Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+           */
+          advance_amount: number;
+
+          /**
+           * The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
+           */
+          advance_paid_out_at: number | null;
+
+          /**
+           * Currency that the financing offer is transacted in. For example, `usd`.
+           */
+          currency: string;
+
+          /**
+           * The chronologically current repayment interval for the financing offer.
+           */
+          current_repayment_interval: Details.CurrentRepaymentInterval | null;
+
+          /**
+           * Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+           */
+          fee_amount: number;
+
+          /**
+           * The amount the Connected account has paid toward the financing debt so far, in minor units. For example, $1,000 USD will be represented as 100000.
+           */
+          paid_amount: number;
+
+          /**
+           * The balance remaining to be paid on the financing, in minor units. For example, $1,000 USD will be represented as 100000.
+           */
+          remaining_amount: number;
+
+          /**
+           * The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
+           */
+          repayments_begin_at: number | null;
+
+          /**
+           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
+           */
+          withhold_rate: number;
+        }
+
+        namespace Details {
+          interface CurrentRepaymentInterval {
+            /**
+             * The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
+             * Given in seconds since unix epoch.
+             */
+            due_at: number;
+
+            /**
+             * The amount that has already been paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
+             */
+            paid_amount: number | null;
+
+            /**
+             * The amount that is yet to be paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
+             */
+            remaining_amount: number;
+          }
+        }
+
+        type Status = 'accepted' | 'delivered' | 'none';
+      }
+    }
+  }
+}

package/types/Capital/FinancingSummaryResource.d.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      interface FinancingSummaryRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class FinancingSummaryResource {
+        /**
+         * Retrieve the financing state for the account that was authenticated in the request.
+         */
+        retrieve(
+          params?: FinancingSummaryRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingSummary>>;
+        retrieve(
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingSummary>>;
+      }
+    }
+  }
+}