stripe 17.2.1 → 17.3.0-beta.1

package/types/Billing/CreditBalanceSummary.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Billing {
       /**
-       * Indicates the credit balance for credits granted to a customer.
+       * Indicates the billing credit balance for billing credits granted to a customer.
        */
       interface CreditBalanceSummary {
         /**
@@ -13,7 +13,7 @@ declare module 'stripe' {
         object: 'billing.credit_balance_summary';
 
         /**
-         * The 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.
+         * 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>;
 
@@ -43,7 +43,7 @@ declare module 'stripe' {
             monetary: AvailableBalance.Monetary | null;
 
             /**
-             * The type of this amount. We currently only support `monetary` credits.
+             * The type of this amount. We currently only support `monetary` billing credits.
              */
             type: 'monetary';
           }
@@ -69,7 +69,7 @@ declare module 'stripe' {
             monetary: LedgerBalance.Monetary | null;
 
             /**
-             * The type of this amount. We currently only support `monetary` credits.
+             * The type of this amount. We currently only support `monetary` billing credits.
              */
             type: 'monetary';
           }

package/types/Billing/CreditBalanceSummaryResource.d.ts

@@ -23,12 +23,12 @@ declare module 'stripe' {
       namespace CreditBalanceSummaryRetrieveParams {
         interface Filter {
           /**
-           * The credit applicability scope for which to fetch balance summary.
+           * The billing credit applicability scope for which to fetch credit balance summary.
            */
           applicability_scope?: Filter.ApplicabilityScope;
 
           /**
-           * The credit grant for which to fetch balance summary.
+           * The credit grant for which to fetch credit balance summary.
            */
           credit_grant?: string;
 

package/types/Billing/CreditBalanceTransactions.d.ts

@@ -23,22 +23,22 @@ declare module 'stripe' {
         created: number;
 
         /**
-         * Credit details for this balance transaction. Only present if type is `credit`.
+         * Credit details for this credit balance transaction. Only present if type is `credit`.
          */
         credit: CreditBalanceTransaction.Credit | null;
 
         /**
-         * The credit grant associated with this balance transaction.
+         * The credit grant associated with this credit balance transaction.
          */
         credit_grant: string | Stripe.Billing.CreditGrant;
 
         /**
-         * Debit details for this balance transaction. Only present if type is `debit`.
+         * Debit details for this credit balance transaction. Only present if type is `debit`.
          */
         debit: CreditBalanceTransaction.Debit | null;
 
         /**
-         * The effective time of this balance transaction.
+         * The effective time of this credit balance transaction.
          */
         effective_at: number;
 
@@ -53,7 +53,7 @@ declare module 'stripe' {
         test_clock: string | Stripe.TestHelpers.TestClock | null;
 
         /**
-         * The type of balance transaction (credit or debit).
+         * The type of credit balance transaction (credit or debit).
          */
         type: CreditBalanceTransaction.Type | null;
       }
@@ -76,7 +76,7 @@ declare module 'stripe' {
             monetary: Amount.Monetary | null;
 
             /**
-             * The type of this amount. We currently only support `monetary` credits.
+             * The type of this amount. We currently only support `monetary` billing credits.
              */
             type: 'monetary';
           }
@@ -100,7 +100,7 @@ declare module 'stripe' {
           amount: Debit.Amount;
 
           /**
-           * Details of how the credits were applied to an invoice. Only present if `type` is `credits_applied`.
+           * Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.
            */
           credits_applied: Debit.CreditsApplied | null;
 
@@ -118,7 +118,7 @@ declare module 'stripe' {
             monetary: Amount.Monetary | null;
 
             /**
-             * The type of this amount. We currently only support `monetary` credits.
+             * The type of this amount. We currently only support `monetary` billing credits.
              */
             type: 'monetary';
           }
@@ -139,12 +139,12 @@ declare module 'stripe' {
 
           interface CreditsApplied {
             /**
-             * The invoice to which the credits were applied.
+             * The invoice to which the billing credits were applied.
              */
             invoice: string | Stripe.Invoice;
 
             /**
-             * The invoice line item to which the credits were applied.
+             * The invoice line item to which the billing credits were applied.
              */
             invoice_line_item: string;
           }

package/types/Billing/CreditGrants.d.ts

@@ -4,7 +4,10 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Billing {
       /**
-       * A credit grant is a resource that records a grant of some credit to a customer.
+       * A credit grant is an API resource that documents the allocation of some billing credits to a customer.
+       *
+       * Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)
+       * end
        */
       interface CreditGrant {
         /**
@@ -22,7 +25,7 @@ declare module 'stripe' {
         applicability_config: CreditGrant.ApplicabilityConfig;
 
         /**
-         * The category of this credit grant.
+         * The category of this credit grant. This is for tracking purposes and will not be displayed to the customer.
          */
         category: CreditGrant.Category;
 
@@ -32,17 +35,17 @@ declare module 'stripe' {
         created: number;
 
         /**
-         * Id of the customer to whom the credit was granted.
+         * ID of the customer to whom the billing credits are granted.
          */
         customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
         /**
-         * The time when the credit becomes effective i.e when it is eligible to be used.
+         * The time when the billing credits become effective i.e when they are eligible to be used.
          */
         effective_at: number | null;
 
         /**
-         * The time when the credit will expire. If not present, the credit will never expire.
+         * The time when the billing credits will expire. If not present, the billing credits will never expire.
          */
         expires_at: number | null;
 
@@ -57,7 +60,7 @@ declare module 'stripe' {
         metadata: Stripe.Metadata;
 
         /**
-         * A descriptive name shown in dashboard and on invoices.
+         * A descriptive name shown in dashboard.
          */
         name: string | null;
 
@@ -85,7 +88,7 @@ declare module 'stripe' {
           monetary: Amount.Monetary | null;
 
           /**
-           * The type of this amount. We currently only support `monetary` credits.
+           * The type of this amount. We currently only support `monetary` billing credits.
            */
           type: 'monetary';
         }
@@ -111,7 +114,7 @@ declare module 'stripe' {
         namespace ApplicabilityConfig {
           interface Scope {
             /**
-             * The price type to which credit grants can apply to. We currently only support `metered` price type.
+             * The price type to which credit grants can apply to. We currently only support `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
              */
             price_type: 'metered';
           }

package/types/Billing/CreditGrantsResource.d.ts

@@ -20,12 +20,12 @@ declare module 'stripe' {
         category: CreditGrantCreateParams.Category;
 
         /**
-         * Id of the customer to whom the credit should be granted.
+         * ID of the customer to whom the billing credits 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.
+         * The time when the billing credits become effective i.e when they are eligible to be used. Defaults to the current timestamp if not specified.
          */
         effective_at?: number;
 
@@ -35,7 +35,7 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * The time when the credit will expire. If not specified, the credit will never expire.
+         * The time when the billing credits will expire. If not specified, the billing credits will never expire.
          */
         expires_at?: number;
 
@@ -45,7 +45,7 @@ declare module 'stripe' {
         metadata?: Stripe.MetadataParam;
 
         /**
-         * A descriptive name shown in dashboard and on invoices.
+         * A descriptive name shown in dashboard.
          */
         name?: string;
       }
@@ -58,7 +58,7 @@ declare module 'stripe' {
           monetary?: Amount.Monetary;
 
           /**
-           * Specify the type of this amount. We currently only support `monetary` credits.
+           * Specify the type of this amount. We currently only support `monetary` billing credits.
            */
           type: 'monetary';
         }
@@ -110,7 +110,7 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * The time when the credit created by this credit grant will expire. If set to empty, the credit will never expire.
+         * The time when the billing credits created by this credit grant will expire. If set to empty, the billing credits will never expire.
          */
         expires_at?: Stripe.Emptyable<number>;
 

package/types/Billing/MeterErrorReports.d.ts

@@ -0,0 +1,106 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * The MeterErrorReport object.
+       */
+      interface MeterErrorReport {
+        /**
+         * 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_error_report';
+
+        reason: MeterErrorReport.Reason;
+
+        /**
+         * The related objects about the error
+         */
+        related_object: MeterErrorReport.RelatedObject | null;
+
+        /**
+         * Summary of invalid events
+         */
+        summary: string;
+
+        /**
+         * Time when validation ended. Measured in seconds since the Unix epoch
+         */
+        validation_end: number;
+
+        /**
+         * Time when validation started. Measured in seconds since the Unix epoch
+         */
+        validation_start: number;
+      }
+
+      namespace MeterErrorReport {
+        interface Reason {
+          /**
+           * The number of errors generated
+           */
+          error_count: number;
+
+          /**
+           * More information about errors
+           */
+          error_types: Array<Reason.ErrorType>;
+        }
+
+        namespace Reason {
+          interface ErrorType {
+            sample_errors: Array<ErrorType.SampleError>;
+          }
+
+          namespace ErrorType {
+            interface SampleError {
+              api_request: SampleError.ApiRequest | null;
+
+              /**
+               * message of the error
+               */
+              error_message: string;
+            }
+
+            namespace SampleError {
+              interface ApiRequest {
+                /**
+                 * Unique identifier for the object.
+                 */
+                id: string;
+
+                /**
+                 * idempotency_key of the request
+                 */
+                idempotency_key: string;
+              }
+            }
+          }
+        }
+
+        interface RelatedObject {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * The type of meter error related object. Should be 'meter'
+           */
+          object: string;
+
+          /**
+           * The url of the meter object
+           */
+          url: string;
+        }
+      }
+    }
+  }
+}

package/types/Billing/Meters.d.ts

@@ -5,6 +5,8 @@ declare module 'stripe' {
     namespace Billing {
       /**
        * A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.
+       *
+       * Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
        */
       interface Meter {
         /**

package/types/BillingPortal/Configurations.d.ts

@@ -209,6 +209,8 @@ declare module 'stripe' {
              * 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;
           }
 
           namespace SubscriptionUpdate {
@@ -230,6 +232,26 @@ declare module 'stripe' {
               | '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';
+              }
+            }
           }
         }
 

package/types/BillingPortal/ConfigurationsResource.d.ts

@@ -5,14 +5,14 @@ declare module 'stripe' {
     namespace BillingPortal {
       interface ConfigurationCreateParams {
         /**
-         * The business information shown to customers in the portal.
+         * Information about the features available in the portal.
          */
-        business_profile: ConfigurationCreateParams.BusinessProfile;
+        features: ConfigurationCreateParams.Features;
 
         /**
-         * Information about the features available in the portal.
+         * The business information shown to customers in the portal.
          */
-        features: ConfigurationCreateParams.Features;
+        business_profile?: ConfigurationCreateParams.BusinessProfile;
 
         /**
          * 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://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
@@ -196,6 +196,11 @@ declare module 'stripe' {
              * Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
              */
             proration_behavior?: SubscriptionUpdate.ProrationBehavior;
+
+            /**
+             * Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
+             */
+            schedule_at_period_end?: SubscriptionUpdate.ScheduleAtPeriodEnd;
           }
 
           namespace SubscriptionUpdate {
@@ -217,6 +222,26 @@ declare module 'stripe' {
               | 'always_invoice'
               | 'create_prorations'
               | 'none';
+
+            interface ScheduleAtPeriodEnd {
+              /**
+               * List of conditions. When any condition is true, the 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';
+              }
+            }
           }
         }
 
@@ -433,6 +458,11 @@ declare module 'stripe' {
              * Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
              */
             proration_behavior?: SubscriptionUpdate.ProrationBehavior;
+
+            /**
+             * Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
+             */
+            schedule_at_period_end?: SubscriptionUpdate.ScheduleAtPeriodEnd;
           }
 
           namespace SubscriptionUpdate {
@@ -454,6 +484,28 @@ declare module 'stripe' {
               | 'always_invoice'
               | 'create_prorations'
               | 'none';
+
+            interface ScheduleAtPeriodEnd {
+              /**
+               * List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
+               */
+              conditions?: Stripe.Emptyable<
+                Array<ScheduleAtPeriodEnd.Condition>
+              >;
+            }
+
+            namespace ScheduleAtPeriodEnd {
+              interface Condition {
+                /**
+                 * The type of condition.
+                 */
+                type: Condition.Type;
+              }
+
+              namespace Condition {
+                type Type = 'decreasing_item_amount' | 'shortening_interval';
+              }
+            }
           }
         }
 

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';
+      }
+    }
+  }
+}