stripe 20.1.2 → 20.2.0-alpha.2

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://docs.stripe.com/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

@@ -98,6 +98,11 @@ declare module 'stripe' {
        */
       livemode: boolean;
 
+      /**
+       * The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+       */
+      margins?: Array<string | Stripe.Margin> | null;
+
       /**
        * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        */
@@ -145,6 +150,21 @@ 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 schedule that generated this invoice item
+         */
+        schedule_details?: Parent.ScheduleDetails | null;
+
         /**
          * Details about the subscription that generated this invoice item
          */
@@ -153,10 +173,61 @@ 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 ScheduleDetails {
+          /**
+           * The subscription schedule that generated this invoice item
+           */
+          schedule: string;
+        }
+
         interface SubscriptionDetails {
           /**
            * The subscription that generated this invoice item
@@ -168,6 +239,12 @@ declare module 'stripe' {
            */
           subscription_item?: string;
         }
+
+        type Type =
+          | 'license_fee_subscription_details'
+          | 'rate_card_subscription_details'
+          | 'schedule_details'
+          | 'subscription_details';
       }
 
       interface Period {
@@ -183,12 +260,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.
@@ -197,17 +278,56 @@ 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.
            */
-          price: string | Stripe.Price;
+          price: string;
 
           /**
            * The ID of the product this item is associated with.
            */
           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/InvoiceItemsResource.d.ts

@@ -48,6 +48,11 @@ declare module 'stripe' {
        */
       invoice?: string;
 
+      /**
+       * The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+       */
+      margins?: Array<string>;
+
       /**
        * Set of [key-value pairs](https://docs.stripe.com/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`.
        */
@@ -111,12 +116,56 @@ declare module 'stripe' {
          */
         discount?: string;
 
+        /**
+         * Details to determine how long the discount should be applied for.
+         */
+        discount_end?: Discount.DiscountEnd;
+
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
+      namespace Discount {
+        interface DiscountEnd {
+          /**
+           * Time span for the redeemed discount.
+           */
+          duration?: DiscountEnd.Duration;
+
+          /**
+           * A precise Unix timestamp for the discount to end. Must be in the future.
+           */
+          timestamp?: number;
+
+          /**
+           * The type of calculation made to determine when the discount ends.
+           */
+          type: DiscountEnd.Type;
+        }
+
+        namespace DiscountEnd {
+          interface Duration {
+            /**
+             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+             */
+            interval: Duration.Interval;
+
+            /**
+             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+             */
+            interval_count: number;
+          }
+
+          namespace Duration {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+          }
+
+          type Type = 'duration' | 'timestamp';
+        }
+      }
+
       interface Period {
         /**
          * The end of the period, which must be greater than or equal to the start. This value is inclusive.
@@ -203,6 +252,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+       */
+      margins?: Stripe.Emptyable<Array<string>>;
+
       /**
        * Set of [key-value pairs](https://docs.stripe.com/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`.
        */
@@ -261,12 +315,56 @@ declare module 'stripe' {
          */
         discount?: string;
 
+        /**
+         * Details to determine how long the discount should be applied for.
+         */
+        discount_end?: Discount.DiscountEnd;
+
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
+      namespace Discount {
+        interface DiscountEnd {
+          /**
+           * Time span for the redeemed discount.
+           */
+          duration?: DiscountEnd.Duration;
+
+          /**
+           * A precise Unix timestamp for the discount to end. Must be in the future.
+           */
+          timestamp?: number;
+
+          /**
+           * The type of calculation made to determine when the discount ends.
+           */
+          type: DiscountEnd.Type;
+        }
+
+        namespace DiscountEnd {
+          interface Duration {
+            /**
+             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+             */
+            interval: Duration.Interval;
+
+            /**
+             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+             */
+            interval_count: number;
+          }
+
+          namespace Duration {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+          }
+
+          type Type = 'duration' | 'timestamp';
+        }
+      }
+
       interface Period {
         /**
          * The end of the period, which must be greater than or equal to the start. This value is inclusive.