stripe 17.1.0 → 17.2.0-beta.2

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.
+           */
+          advance_amount: number;
+
+          /**
+           * Currency that the financing offer is transacted in. For example, `usd`.
+           */
+          currency: string;
+
+          /**
+           * Fixed fee amount, in minor units.
+           */
+          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.
+           */
+          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.
+           */
+          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' | '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.
+           */
+          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.
+           */
+          fee_amount: number;
+
+          /**
+           * The amount the Connected account has paid toward the financing debt so far.
+           */
+          paid_amount: number;
+
+          /**
+           * The balance remaining to be paid on the financing, in minor units.
+           */
+          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.
+             */
+            paid_amount: number | null;
+
+            /**
+             * The amount that is yet to be paid in the current repayment interval.
+             */
+            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>>;
+      }
+    }
+  }
+}

package/types/Capital/FinancingTransactions.d.ts

@@ -0,0 +1,135 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      /**
+       * This is an object representing the details of a transaction on a Capital financing object.
+       */
+      interface FinancingTransaction {
+        /**
+         * A unique identifier for the financing transaction object.
+         */
+        id: string;
+
+        /**
+         * The object type: financing_transaction
+         */
+        object: 'capital.financing_transaction';
+
+        /**
+         * The ID of the merchant associated with this financing transaction.
+         */
+        account: string;
+
+        /**
+         * Time at which the financing transaction was created. Given in seconds since unix epoch.
+         */
+        created_at: number;
+
+        /**
+         * This is an object representing a transaction on a Capital financing offer.
+         */
+        details: FinancingTransaction.Details;
+
+        /**
+         * The Capital financing offer for this financing transaction.
+         */
+        financing_offer: string | null;
+
+        /**
+         * The Capital transaction object that predates the Financing Transactions API and
+         * corresponds with the balance transaction that was created as a result of this
+         * financing transaction.
+         */
+        legacy_balance_transaction_source?: 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 type of the financing transaction.
+         */
+        type: FinancingTransaction.Type;
+
+        /**
+         * A human-friendly description of the financing transaction.
+         */
+        user_facing_description: string | null;
+      }
+
+      namespace FinancingTransaction {
+        interface Details {
+          /**
+           * The advance amount being repaid, paid out, or reversed in minor units.
+           */
+          advance_amount: number;
+
+          /**
+           * The currency of the financing transaction.
+           */
+          currency: string;
+
+          /**
+           * The fee amount being repaid, paid out, or reversed in minor units.
+           */
+          fee_amount: number;
+
+          /**
+           * The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
+           */
+          linked_payment?: string;
+
+          /**
+           * The reason for the financing transaction (if applicable).
+           */
+          reason?: Details.Reason;
+
+          /**
+           * The reversed transaction. This field only applies to financing
+           * transactions of type `reversal`.
+           */
+          reversed_transaction?: string;
+
+          /**
+           * The advance and fee amount being repaid, paid out, or reversed in minor units.
+           */
+          total_amount: number;
+
+          /**
+           * This is an object representing a linked transaction on a Capital Financing Transaction.
+           */
+          transaction?: Details.Transaction;
+        }
+
+        namespace Details {
+          type Reason =
+            | 'automatic_withholding'
+            | 'automatic_withholding_refund'
+            | 'collection'
+            | 'collection_failure'
+            | 'financing_cancellation'
+            | 'refill'
+            | 'requested_by_user'
+            | 'user_initiated';
+
+          interface Transaction {
+            /**
+             * The linked payment ID.
+             */
+            charge?: string;
+
+            /**
+             * The linked Treasury Financing Transaction ID.
+             */
+            treasury_transaction?: string;
+          }
+        }
+
+        type Type = 'payment' | 'payout' | 'reversal';
+      }
+    }
+  }
+}

package/types/Capital/FinancingTransactionsResource.d.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      interface FinancingTransactionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FinancingTransactionListParams extends PaginationParams {
+        /**
+         * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
+         */
+        charge?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Returns transactions that were created that apply to this financing offer ID.
+         */
+        financing_offer?: string;
+
+        /**
+         * Only returns transactions that are responsible for reversing this financing transaction ID.
+         */
+        reversed_transaction?: string;
+
+        /**
+         * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
+         */
+        treasury_transaction?: string;
+      }
+
+      class FinancingTransactionsResource {
+        /**
+         * Retrieves a financing transaction for a financing offer.
+         */
+        retrieve(
+          id: string,
+          params?: FinancingTransactionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
+
+        /**
+         * Returns a list of financing transactions. The transactions are returned in sorted order,
+         * with the most recent transactions appearing first.
+         */
+        list(
+          params?: FinancingTransactionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
+      }
+    }
+  }
+}