stripe 19.4.0-alpha.1 → 19.4.0-alpha.2

package/types/Issuing/Programs.d.ts

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      /**
+       * An Issuing `Program` represents a card program that the user has access to.
+       */
+      interface Program {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'issuing.program';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Whether or not this is the "default" issuing program new cards are created on. Only one active `is_default` program at the same time.
+         */
+        is_default: 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;
+
+        /**
+         * The platform's Issuing Program for which this program is associated.
+         */
+        platform_program: string | null;
+      }
+    }
+  }
+}

package/types/Issuing/ProgramsResource.d.ts

@@ -0,0 +1,96 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      interface ProgramCreateParams {
+        /**
+         * The program to use as the parent for the new program to create.
+         */
+        platform_program: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * If true, makes the specified program the default for the given account.
+         */
+        is_default?: boolean;
+      }
+
+      interface ProgramRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ProgramUpdateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * If true, makes the specified program the default.
+         */
+        is_default?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+      }
+
+      interface ProgramListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class ProgramsResource {
+        /**
+         * Create a Program object.
+         */
+        create(
+          params: ProgramCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
+
+        /**
+         * Retrieves the program specified by the given id.
+         */
+        retrieve(
+          id: string,
+          params?: ProgramRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
+
+        /**
+         * Updates a Program object.
+         */
+        update(
+          id: string,
+          params?: ProgramUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
+
+        /**
+         * List all of the programs the given Issuing user has access to.
+         */
+        list(
+          params?: ProgramListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.Program>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Issuing.Program>;
+      }
+    }
+  }
+}

package/types/Persons.d.ts

@@ -165,6 +165,10 @@ declare module 'stripe' {
        */
       requirements?: Person.Requirements | null;
 
+      self_reported_income?: Person.SelfReportedIncome;
+
+      self_reported_monthly_housing_payment?: Person.SelfReportedMonthlyHousingPayment;
+
       /**
        * Whether the last four digits of the person's Social Security number have been provided (U.S. only).
        */
@@ -670,6 +674,30 @@ declare module 'stripe' {
         }
       }
 
+      interface SelfReportedIncome {
+        /**
+         * Amount in the minor currency unit (e.g., cents for USD)
+         */
+        amount: number;
+
+        /**
+         * 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;
+      }
+
+      interface SelfReportedMonthlyHousingPayment {
+        /**
+         * Amount in the minor currency unit (e.g., cents for USD)
+         */
+        amount: number;
+
+        /**
+         * 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;
+      }
+
       interface UsCfpbData {
         /**
          * The persons ethnicity details

package/types/QuotePreviewInvoices.d.ts

@@ -1093,6 +1093,11 @@ declare module 'stripe' {
          * The type of parent that generated this invoice
          */
         type: Parent.Type;
+
+        /**
+         * Details about the schedule that generated this invoice
+         */
+        schedule_details?: Parent.ScheduleDetails | null;
       }
 
       namespace Parent {
@@ -1110,6 +1115,13 @@ declare module 'stripe' {
           quote: string;
         }
 
+        interface ScheduleDetails {
+          /**
+           * The schedule that generated this invoice
+           */
+          schedule: string;
+        }
+
         interface SubscriptionDetails {
           /**
            * Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
@@ -1154,6 +1166,7 @@ declare module 'stripe' {
         type Type =
           | 'billing_cadence_details'
           | 'quote_details'
+          | 'schedule_details'
           | 'subscription_details';
       }
 

package/types/QuotePreviewSubscriptionSchedules.d.ts

@@ -37,6 +37,13 @@ declare module 'stripe' {
        */
       billing_mode: QuotePreviewSubscriptionSchedule.BillingMode;
 
+      /**
+       * Billing schedules for this subscription schedule.
+       */
+      billing_schedules?: Array<
+        QuotePreviewSubscriptionSchedule.BillingSchedule
+      > | null;
+
       /**
        * Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
        */
@@ -79,6 +86,11 @@ declare module 'stripe' {
        */
       last_price_migration_error?: QuotePreviewSubscriptionSchedule.LastPriceMigrationError | null;
 
+      /**
+       * The most recent invoice this subscription schedule has generated.
+       */
+      latest_invoice?: string | Stripe.Invoice | null;
+
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */
@@ -181,6 +193,187 @@ declare module 'stripe' {
         type Type = 'classic' | 'flexible';
       }
 
+      interface BillingSchedule {
+        /**
+         * Specifies which subscription items the billing schedule applies to.
+         */
+        applies_to: Array<BillingSchedule.AppliesTo> | null;
+
+        /**
+         * Specifies the billing period.
+         */
+        bill_until: BillingSchedule.BillUntil;
+
+        /**
+         * Unique identifier for the billing schedule.
+         */
+        key: string;
+
+        /**
+         * Specifies the start of the billing period.
+         */
+        bill_from?: BillingSchedule.BillFrom | null;
+      }
+
+      namespace BillingSchedule {
+        interface AppliesTo {
+          /**
+           * The billing schedule will apply to the subscription item with the given price ID.
+           */
+          price: string | Stripe.Price | null;
+
+          /**
+           * Controls which subscription items the billing schedule applies to.
+           */
+          type: 'price';
+        }
+
+        interface BillFrom {
+          /**
+           * Use an index to specify the position of an amendment to start prebilling with.
+           */
+          amendment_start: BillFrom.AmendmentStart | null;
+
+          /**
+           * The time the billing schedule applies from.
+           */
+          computed_timestamp: number | null;
+
+          /**
+           * Lets you bill the period starting from a particular Quote line.
+           */
+          line_starts_at: BillFrom.LineStartsAt | null;
+
+          /**
+           * Timestamp is calculated from the request time.
+           */
+          relative: BillFrom.Relative | null;
+
+          /**
+           * Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
+           */
+          timestamp: number | null;
+
+          /**
+           * Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
+           */
+          type: BillFrom.Type;
+        }
+
+        namespace BillFrom {
+          interface AmendmentStart {
+            /**
+             * Use an index to specify the position of an amendment to start prebilling with.
+             */
+            index: number;
+          }
+
+          interface LineStartsAt {
+            /**
+             * Unique identifier for the object.
+             */
+            id: string;
+          }
+
+          interface Relative {
+            /**
+             * Specifies billing duration. Possible values are `day`, `week`, `month`, or `year`.
+             */
+            interval: Relative.Interval;
+
+            /**
+             * The multiplier applied to the interval.
+             */
+            interval_count: number | null;
+          }
+
+          namespace Relative {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+          }
+
+          type Type =
+            | 'amendment_start'
+            | 'line_starts_at'
+            | 'now'
+            | 'pause_collection_start'
+            | 'quote_acceptance_date'
+            | 'relative'
+            | 'timestamp';
+        }
+
+        interface BillUntil {
+          /**
+           * The timestamp the billing schedule will apply until.
+           */
+          computed_timestamp: number;
+
+          /**
+           * Specifies the billing period.
+           */
+          duration: BillUntil.Duration | null;
+
+          /**
+           * If specified, the billing schedule will apply until the specified timestamp.
+           */
+          timestamp: number | null;
+
+          /**
+           * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+           */
+          type: BillUntil.Type;
+
+          /**
+           * Use an index to specify the position of an amendment to end prebilling with.
+           */
+          amendment_end?: BillUntil.AmendmentEnd | null;
+
+          /**
+           * Lets you bill the period ending at a particular Quote line.
+           */
+          line_ends_at?: BillUntil.LineEndsAt | null;
+        }
+
+        namespace BillUntil {
+          interface AmendmentEnd {
+            /**
+             * Use an index to specify the position of an amendment to end prebilling with.
+             */
+            index: number;
+          }
+
+          interface Duration {
+            /**
+             * Specifies billing duration. Either `day`, `week`, `month` or `year`.
+             */
+            interval: Duration.Interval;
+
+            /**
+             * The multiplier applied to the interval.
+             */
+            interval_count: number | null;
+          }
+
+          namespace Duration {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+          }
+
+          interface LineEndsAt {
+            /**
+             * Unique identifier for the object.
+             */
+            id: string;
+          }
+
+          type Type =
+            | 'amendment_end'
+            | 'duration'
+            | 'line_ends_at'
+            | 'schedule_end'
+            | 'timestamp'
+            | 'upcoming_invoice';
+        }
+      }
+
       interface CurrentPhase {
         /**
          * The end of this phase of the subscription schedule.
@@ -237,6 +430,11 @@ declare module 'stripe' {
          * The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
          */
         transfer_data: DefaultSettings.TransferData | null;
+
+        /**
+         * Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
+         */
+        phase_effective_at?: DefaultSettings.PhaseEffectiveAt | null;
       }
 
       namespace DefaultSettings {
@@ -325,6 +523,8 @@ declare module 'stripe' {
           }
         }
 
+        type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
+
         interface TransferData {
           /**
            * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.