stripe 19.3.0-beta.1 → 19.4.0-alpha.1

package/types/Identity/BlocklistEntriesResource.d.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Identity {
+      interface BlocklistEntryCreateParams {
+        /**
+         * The type of blocklist entry to be created.
+         */
+        entry_type: BlocklistEntryCreateParams.EntryType;
+
+        /**
+         * The identifier of the VerificationReport to create the BlocklistEntry from.
+         */
+        verification_report: string;
+
+        /**
+         * When true, the created BlocklistEntry will be used to retroactively unverify matching verifications.
+         */
+        check_existing_verifications?: boolean;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace BlocklistEntryCreateParams {
+        type EntryType = 'document' | 'selfie';
+      }
+
+      interface BlocklistEntryRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface BlocklistEntryListParams extends PaginationParams {
+        /**
+         * Only return BlocklistEntries that were created during the given date interval.
+         */
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return blocklist entries with the specified status.
+         */
+        status?: BlocklistEntryListParams.Status;
+
+        /**
+         * Only return blocklist entries of the specified type.
+         */
+        type?: BlocklistEntryListParams.Type;
+
+        /**
+         * Only return blocklist entries created from this verification report.
+         */
+        verification_report?: string;
+      }
+
+      namespace BlocklistEntryListParams {
+        type Status = 'active' | 'disabled' | 'redacted';
+
+        type Type = 'document' | 'selfie';
+      }
+
+      interface BlocklistEntryDisableParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class BlocklistEntriesResource {
+        /**
+         * Creates a BlocklistEntry object from a verification report.
+         *
+         * A blocklist entry prevents future identity verifications that match the same identity information.
+         * You can create blocklist entries from verification reports that contain document extracted data
+         * or a selfie.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#add-a-blocklist-entry)
+         */
+        create(
+          params: BlocklistEntryCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+
+        /**
+         * Retrieves a BlocklistEntry object by its identifier.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+         */
+        retrieve(
+          id: string,
+          params?: BlocklistEntryRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+
+        /**
+         * Returns a list of BlocklistEntry objects associated with your account.
+         *
+         * The blocklist entries are returned sorted by creation date, with the most recently created
+         * entries appearing first.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+         */
+        list(
+          params?: BlocklistEntryListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Identity.BlocklistEntry>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Identity.BlocklistEntry>;
+
+        /**
+         * Disables a BlocklistEntry object.
+         *
+         * After a BlocklistEntry is disabled, it will no longer block future verifications that match
+         * the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+         * must be created using the same verification report.
+         *
+         * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+         */
+        disable(
+          id: string,
+          params?: BlocklistEntryDisableParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+        disable(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.BlocklistEntry>>;
+      }
+    }
+  }
+}

package/types/Identity/VerificationReports.d.ts

@@ -92,6 +92,11 @@ declare module 'stripe' {
            */
           address: Stripe.Address | null;
 
+          /**
+           * If document was not verified due to extracted data being on the blocklist, this is the token of the BlocklistEntry that blocked it
+           */
+          blocked_by_entry?: string | Stripe.Identity.BlocklistEntry | null;
+
           /**
            * Date of birth as it appears in the document.
            */
@@ -435,6 +440,11 @@ declare module 'stripe' {
         }
 
         interface Selfie {
+          /**
+           * If selfie was not verified due to being on the blocklist, this is the token of the BlocklistEntry that blocked it
+           */
+          blocked_by_entry?: string | Stripe.Identity.BlocklistEntry | null;
+
           /**
            * ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.
            */

package/types/Identity/VerificationReportsResource.d.ts

@@ -11,6 +11,11 @@ declare module 'stripe' {
       }
 
       interface VerificationReportListParams extends PaginationParams {
+        /**
+         * Only return VerificationReports that were blocked by this BlocklistEntry id.
+         */
+        blocked_by_entry?: string;
+
         /**
          * A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
          */

package/types/InvoiceItems.d.ts

@@ -150,6 +150,16 @@ declare module 'stripe' {
 
     namespace InvoiceItem {
       interface Parent {
+        /**
+         * Details about the license fee subscription that generated this invoice item
+         */
+        license_fee_subscription_details?: Parent.LicenseFeeSubscriptionDetails | null;
+
+        /**
+         * Details about the rate card subscription that generated this invoice item
+         */
+        rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
+
         /**
          * Details about the subscription that generated this invoice item
          */
@@ -158,10 +168,54 @@ declare module 'stripe' {
         /**
          * The type of parent that generated this invoice item
          */
-        type: 'subscription_details';
+        type: Parent.Type;
       }
 
       namespace Parent {
+        interface LicenseFeeSubscriptionDetails {
+          /**
+           * The license fee subscription that generated this invoice item
+           */
+          license_fee_subscription: string;
+
+          /**
+           * The license fee version that generated this invoice item
+           */
+          license_fee_version: string;
+
+          /**
+           * The pricing plan subscription that manages the license fee subscription
+           */
+          pricing_plan_subscription: string;
+
+          /**
+           * The pricing plan version at the time this invoice item was generated
+           */
+          pricing_plan_version: string;
+        }
+
+        interface RateCardSubscriptionDetails {
+          /**
+           * The pricing plan subscription that manages the rate card subscription
+           */
+          pricing_plan_subscription?: string | null;
+
+          /**
+           * The pricing plan version at the time this invoice item was generated
+           */
+          pricing_plan_version?: string | null;
+
+          /**
+           * The rate card subscription that generated this invoice item
+           */
+          rate_card_subscription: string;
+
+          /**
+           * The rate card version that generated this invoice item
+           */
+          rate_card_version: string;
+        }
+
         interface SubscriptionDetails {
           /**
            * The subscription that generated this invoice item
@@ -173,6 +227,11 @@ declare module 'stripe' {
            */
           subscription_item?: string;
         }
+
+        type Type =
+          | 'license_fee_subscription_details'
+          | 'rate_card_subscription_details'
+          | 'subscription_details';
       }
 
       interface Period {
@@ -188,12 +247,16 @@ declare module 'stripe' {
       }
 
       interface Pricing {
+        license_fee_details?: Pricing.LicenseFeeDetails;
+
         price_details?: Pricing.PriceDetails;
 
+        rate_card_rate_details?: Pricing.RateCardRateDetails;
+
         /**
          * The type of the pricing details.
          */
-        type: 'price_details';
+        type: Pricing.Type;
 
         /**
          * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
@@ -202,6 +265,23 @@ declare module 'stripe' {
       }
 
       namespace Pricing {
+        interface LicenseFeeDetails {
+          /**
+           * The ID of the license fee this item is associated with
+           */
+          license_fee: string;
+
+          /**
+           * The version of the license fee this item is associated with
+           */
+          license_fee_version: string;
+
+          /**
+           * The ID of the licensed item this item is associated with
+           */
+          licensed_item: string;
+        }
+
         interface PriceDetails {
           /**
            * The ID of the price this item is associated with.
@@ -213,6 +293,28 @@ declare module 'stripe' {
            */
           product: string;
         }
+
+        interface RateCardRateDetails {
+          /**
+           * The ID of billable item this item is associated with
+           */
+          metered_item: string;
+
+          /**
+           * The ID of the rate card this item is associated with
+           */
+          rate_card: string;
+
+          /**
+           * The ID of the rate card rate this item is associated with
+           */
+          rate_card_rate: string;
+        }
+
+        type Type =
+          | 'license_fee_details'
+          | 'price_details'
+          | 'rate_card_rate_details';
       }
 
       interface ProrationDetails {

package/types/InvoiceLineItems.d.ts

@@ -139,6 +139,16 @@ declare module 'stripe' {
          */
         invoice_item_details: Parent.InvoiceItemDetails | null;
 
+        /**
+         * Details about the license fee subscription that generated this line item
+         */
+        license_fee_subscription_details?: Parent.LicenseFeeSubscriptionDetails | null;
+
+        /**
+         * Details about the rate card subscription that generated this line item
+         */
+        rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
+
         /**
          * Details about the subscription item that generated this line item
          */
@@ -196,6 +206,60 @@ declare module 'stripe' {
           }
         }
 
+        interface LicenseFeeSubscriptionDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * The license fee subscription that generated this line item
+           */
+          license_fee_subscription: string;
+
+          /**
+           * The license fee version at the time this line item was generated
+           */
+          license_fee_version: string;
+
+          /**
+           * The pricing plan subscription that manages the license fee subscription
+           */
+          pricing_plan_subscription: string;
+
+          /**
+           * The pricing plan version at the time this line item was generated
+           */
+          pricing_plan_version: string;
+        }
+
+        interface RateCardSubscriptionDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * The pricing plan subscription that manages the rate card subscription
+           */
+          pricing_plan_subscription?: string | null;
+
+          /**
+           * The pricing plan version at the time this line item was generated
+           */
+          pricing_plan_version?: string | null;
+
+          /**
+           * The rate card subscription that generated this line item
+           */
+          rate_card_subscription: string;
+
+          /**
+           * The rate card version at the time this line item was generated
+           */
+          rate_card_version: string;
+        }
+
         interface SubscriptionItemDetails {
           /**
            * The invoice item that generated this line item
@@ -246,7 +310,11 @@ declare module 'stripe' {
           }
         }
 
-        type Type = 'invoice_item_details' | 'subscription_item_details';
+        type Type =
+          | 'invoice_item_details'
+          | 'license_fee_subscription_details'
+          | 'rate_card_subscription_details'
+          | 'subscription_item_details';
       }
 
       interface Period {
@@ -296,12 +364,16 @@ declare module 'stripe' {
       }
 
       interface Pricing {
+        license_fee_details?: Pricing.LicenseFeeDetails;
+
         price_details?: Pricing.PriceDetails;
 
+        rate_card_rate_details?: Pricing.RateCardRateDetails;
+
         /**
          * The type of the pricing details.
          */
-        type: 'price_details';
+        type: Pricing.Type;
 
         /**
          * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
@@ -310,6 +382,23 @@ declare module 'stripe' {
       }
 
       namespace Pricing {
+        interface LicenseFeeDetails {
+          /**
+           * The ID of the license fee this item is associated with
+           */
+          license_fee: string;
+
+          /**
+           * The version of the license fee this item is associated with
+           */
+          license_fee_version: string;
+
+          /**
+           * The ID of the licensed item this item is associated with
+           */
+          licensed_item: string;
+        }
+
         interface PriceDetails {
           /**
            * The ID of the price this item is associated with.
@@ -321,6 +410,28 @@ declare module 'stripe' {
            */
           product: string;
         }
+
+        interface RateCardRateDetails {
+          /**
+           * The ID of billable item this item is associated with
+           */
+          metered_item: string;
+
+          /**
+           * The ID of the rate card this item is associated with
+           */
+          rate_card: string;
+
+          /**
+           * The ID of the rate card rate this item is associated with
+           */
+          rate_card_rate: string;
+        }
+
+        type Type =
+          | 'license_fee_details'
+          | 'price_details'
+          | 'rate_card_rate_details';
       }
 
       interface Tax {

package/types/InvoicePayments.d.ts

@@ -92,7 +92,7 @@ declare module 'stripe' {
       }
 
       namespace Payment {
-        type Type = 'charge' | 'payment_intent';
+        type Type = 'charge' | 'payment_intent' | 'payment_record';
       }
 
       interface StatusTransitions {

package/types/InvoicesResource.d.ts

@@ -1790,6 +1790,11 @@ declare module 'stripe' {
     }
 
     interface InvoiceListParams extends PaginationParams {
+      /**
+       * Only return invoices for the cadence specified by this billing cadence ID.
+       */
+      billing_cadence?: string;
+
       /**
        * The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
        */

package/types/PaymentIntentAmountDetailsLineItems.d.ts

@@ -17,9 +17,7 @@ declare module 'stripe' {
       object: 'payment_intent_amount_details_line_item';
 
       /**
-       * The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
-       *
-       * This field is mutually exclusive with the `amount_details[discount_amount]` field.
+       * The amount an item was discounted for. Positive integer.
        */
       discount_amount: number | null;
 
@@ -29,19 +27,17 @@ declare module 'stripe' {
       payment_method_options: PaymentIntentAmountDetailsLineItem.PaymentMethodOptions | null;
 
       /**
-       * The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.
+       * Unique identifier of the product. At most 12 characters long.
        */
       product_code: string | null;
 
       /**
-       * The product name of the line item. Required for L3 rates. At most 1024 characters long.
-       *
-       * For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters.
+       * Name of the product. At most 100 characters long.
        */
       product_name: string;
 
       /**
-       * The quantity of items. Required for L3 rates. An integer greater than 0.
+       * Number of items of the product. Positive integer.
        */
       quantity: number;
 
@@ -51,12 +47,12 @@ declare module 'stripe' {
       tax: PaymentIntentAmountDetailsLineItem.Tax | null;
 
       /**
-       * The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
+       * Cost of the product. Non-negative integer.
        */
       unit_cost: number;
 
       /**
-       * A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long.
+       * A unit of measure for the line item, such as gallons, feet, meters, etc.
        */
       unit_of_measure: string | null;
     }
@@ -115,9 +111,7 @@ declare module 'stripe' {
 
       interface Tax {
         /**
-         * The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
-         *
-         * This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
+         * Total portion of the amount that is for tax.
          */
         total_tax_amount: number;
       }