stripe 19.1.0 → 19.2.0-alpha.2

package/types/V2/Billing/ServiceActionsResource.d.ts

@@ -0,0 +1,370 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface ServiceActionCreateParams {
+          /**
+           * The interval for assessing service.
+           */
+          service_interval: ServiceActionCreateParams.ServiceInterval;
+
+          /**
+           * The length of the interval for assessing service.
+           */
+          service_interval_count: number;
+
+          /**
+           * The type of the service action.
+           */
+          type: ServiceActionCreateParams.Type;
+
+          /**
+           * Details for the credit grant. Required if `type` is `credit_grant`.
+           */
+          credit_grant?: ServiceActionCreateParams.CreditGrant;
+
+          /**
+           * Details for the credit grant per tenant. Required if `type` is `credit_grant_per_tenant`.
+           */
+          credit_grant_per_tenant?: ServiceActionCreateParams.CreditGrantPerTenant;
+
+          /**
+           * An internal key you can use to search for this service action. Maximum length of 200 characters.
+           */
+          lookup_key?: string;
+        }
+
+        namespace ServiceActionCreateParams {
+          interface CreditGrant {
+            /**
+             * The amount of the credit grant.
+             */
+            amount: CreditGrant.Amount;
+
+            /**
+             * Defines the scope where the credit grant is applicable.
+             */
+            applicability_config: CreditGrant.ApplicabilityConfig;
+
+            /**
+             * The category of the credit grant.
+             */
+            category?: CreditGrant.Category;
+
+            /**
+             * The expiry configuration for the credit grant.
+             */
+            expiry_config: CreditGrant.ExpiryConfig;
+
+            /**
+             * A descriptive name shown in dashboard.
+             */
+            name: string;
+
+            /**
+             * The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
+             */
+            priority?: number;
+          }
+
+          namespace CreditGrant {
+            interface Amount {
+              /**
+               * The type of the credit grant amount. We currently support `monetary` and `custom_pricing_unit` billing credits.
+               */
+              type: Amount.Type;
+
+              /**
+               * The custom pricing unit amount of the credit grant. Required if `type` is `custom_pricing_unit`.
+               */
+              custom_pricing_unit?: Amount.CustomPricingUnit;
+
+              /**
+               * The monetary amount of the credit grant. Required if `type` is `monetary`.
+               */
+              monetary?: V2.Amount;
+            }
+
+            namespace Amount {
+              interface CustomPricingUnit {
+                /**
+                 * The id of the custom pricing unit.
+                 */
+                id: string;
+
+                /**
+                 * The value of the credit grant, decimal value represented as a string.
+                 */
+                value: string;
+              }
+
+              type Type = 'custom_pricing_unit' | 'monetary';
+            }
+
+            interface ApplicabilityConfig {
+              /**
+               * The applicability scope of the credit grant.
+               */
+              scope: ApplicabilityConfig.Scope;
+            }
+
+            namespace ApplicabilityConfig {
+              interface Scope {
+                /**
+                 * The billable items to apply the credit grant to.
+                 */
+                billable_items?: Array<string>;
+
+                /**
+                 * The price type that credit grants can apply to. We currently only support the `metered` price type. This will apply to metered prices and rate cards. Cannot be used in combination with `billable_items`.
+                 */
+                price_type?: 'metered';
+              }
+            }
+
+            type Category = 'paid' | 'promotional';
+
+            interface ExpiryConfig {
+              /**
+               * The type of the expiry configuration. We currently support `end_of_service_period`.
+               */
+              type: 'end_of_service_period';
+            }
+          }
+
+          interface CreditGrantPerTenant {
+            /**
+             * The amount of the credit grant.
+             */
+            amount: CreditGrantPerTenant.Amount;
+
+            /**
+             * Defines the scope where the credit grant is applicable.
+             */
+            applicability_config: CreditGrantPerTenant.ApplicabilityConfig;
+
+            /**
+             * The category of the credit grant.
+             */
+            category?: CreditGrantPerTenant.Category;
+
+            /**
+             * The expiry configuration for the credit grant.
+             */
+            expiry_config: CreditGrantPerTenant.ExpiryConfig;
+
+            /**
+             * The grant condition for the credit grant.
+             */
+            grant_condition: CreditGrantPerTenant.GrantCondition;
+
+            /**
+             * Customer-facing name for the credit grant.
+             */
+            name: string;
+
+            /**
+             * The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
+             */
+            priority?: number;
+          }
+
+          namespace CreditGrantPerTenant {
+            interface Amount {
+              /**
+               * The type of the credit grant amount. We currently support `monetary` and `custom_pricing_unit` billing credits.
+               */
+              type: Amount.Type;
+
+              /**
+               * The custom pricing unit amount of the credit grant. Required if `type` is `custom_pricing_unit`.
+               */
+              custom_pricing_unit?: Amount.CustomPricingUnit;
+
+              /**
+               * The monetary amount of the credit grant. Required if `type` is `monetary`.
+               */
+              monetary?: V2.Amount;
+            }
+
+            namespace Amount {
+              interface CustomPricingUnit {
+                /**
+                 * The id of the custom pricing unit.
+                 */
+                id: string;
+
+                /**
+                 * The value of the credit grant, decimal value represented as a string.
+                 */
+                value: string;
+              }
+
+              type Type = 'custom_pricing_unit' | 'monetary';
+            }
+
+            interface ApplicabilityConfig {
+              /**
+               * The applicability scope of the credit grant.
+               */
+              scope: ApplicabilityConfig.Scope;
+            }
+
+            namespace ApplicabilityConfig {
+              interface Scope {
+                /**
+                 * The billable items to apply the credit grant to.
+                 */
+                billable_items?: Array<string>;
+
+                /**
+                 * The price type that credit grants can apply to. We currently only support the `metered` price type. This will apply to metered prices and rate cards. Cannot be used in combination with `billable_items`.
+                 */
+                price_type?: 'metered';
+              }
+            }
+
+            type Category = 'paid' | 'promotional';
+
+            interface ExpiryConfig {
+              /**
+               * The type of the expiry configuration. We currently support `end_of_service_period`.
+               */
+              type: 'end_of_service_period';
+            }
+
+            interface GrantCondition {
+              /**
+               * The type of the grant condition. We currently support `meter_event_first_per_period`.
+               */
+              type: 'meter_event_first_per_period';
+
+              /**
+               * The grant condition for the meter event first per period.
+               */
+              meter_event_first_per_period?: GrantCondition.MeterEventFirstPerPeriod;
+            }
+
+            namespace GrantCondition {
+              interface MeterEventFirstPerPeriod {
+                /**
+                 * The meter segment conditions for the grant condition.
+                 */
+                meter_segment_conditions: Array<
+                  MeterEventFirstPerPeriod.MeterSegmentCondition
+                >;
+              }
+
+              namespace MeterEventFirstPerPeriod {
+                interface MeterSegmentCondition {
+                  /**
+                   * The type of the meter segment condition. We currently support `dimension`.
+                   */
+                  type: 'dimension';
+
+                  /**
+                   * Dimension-based meter segment condition.
+                   */
+                  dimension?: MeterSegmentCondition.Dimension;
+                }
+
+                namespace MeterSegmentCondition {
+                  interface Dimension {
+                    /**
+                     * The payload key for the dimension.
+                     */
+                    payload_key: string;
+
+                    /**
+                     * The value for the dimension.
+                     */
+                    value: string;
+                  }
+                }
+              }
+            }
+          }
+
+          type ServiceInterval = 'day' | 'month' | 'week' | 'year';
+
+          type Type = 'credit_grant' | 'credit_grant_per_tenant';
+        }
+      }
+
+      namespace Billing {
+        interface ServiceActionRetrieveParams {}
+      }
+
+      namespace Billing {
+        interface ServiceActionUpdateParams {
+          /**
+           * Details for the credit grant. Can only be set if the service action's `type` is `credit_grant`.
+           */
+          credit_grant?: ServiceActionUpdateParams.CreditGrant;
+
+          /**
+           * Details for the credit grant per tenant. Can only be set if the service action's `type` is `credit_grant_per_tenant`.
+           */
+          credit_grant_per_tenant?: ServiceActionUpdateParams.CreditGrantPerTenant;
+
+          /**
+           * An internal key you can use to search for this service action. Maximum length of 200 characters.
+           */
+          lookup_key?: string;
+        }
+
+        namespace ServiceActionUpdateParams {
+          interface CreditGrant {
+            /**
+             * A descriptive name shown in dashboard.
+             */
+            name?: string;
+          }
+
+          interface CreditGrantPerTenant {
+            /**
+             * A descriptive name shown in dashboard.
+             */
+            name?: string;
+          }
+        }
+      }
+
+      namespace Billing {
+        class ServiceActionsResource {
+          /**
+           * Create a Service Action object.
+           */
+          create(
+            params: ServiceActionCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.ServiceAction>>;
+
+          /**
+           * Retrieve a Service Action object.
+           */
+          retrieve(
+            id: string,
+            params?: ServiceActionRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.ServiceAction>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.ServiceAction>>;
+
+          /**
+           * Update a ServiceAction object.
+           */
+          update(
+            id: string,
+            params?: ServiceActionUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.ServiceAction>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Core/AccountLinks.d.ts

@@ -0,0 +1,168 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        /**
+         * AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users enrolled in the public preview for Accounts v2.
+         */
+        interface AccountLink {
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.core.account_link';
+
+          /**
+           * The ID of the Account the link was created for.
+           */
+          account: string;
+
+          /**
+           * The timestamp at which this AccountLink was created.
+           */
+          created: string;
+
+          /**
+           * The timestamp at which this AccountLink will expire.
+           */
+          expires_at: 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 URL for the AccountLink.
+           */
+          url: string;
+
+          /**
+           * The use case of AccountLink the user is requesting.
+           */
+          use_case: AccountLink.UseCase;
+        }
+
+        namespace AccountLink {
+          interface UseCase {
+            /**
+             * Open Enum. The type of AccountLink the user is requesting.
+             */
+            type: UseCase.Type;
+
+            /**
+             * Indicates that the AccountLink provided should onboard an account.
+             */
+            account_onboarding?: UseCase.AccountOnboarding;
+
+            /**
+             * Indicates that the AccountLink provided should update a previously onboarded account.
+             */
+            account_update?: UseCase.AccountUpdate;
+          }
+
+          namespace UseCase {
+            interface AccountOnboarding {
+              /**
+               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
+               */
+              collection_options?: AccountOnboarding.CollectionOptions;
+
+              /**
+               * Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
+               */
+              configurations: Array<AccountOnboarding.Configuration>;
+
+              /**
+               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
+               */
+              refresh_url: string;
+
+              /**
+               * The URL that the user will be redirected to upon completing the linked flow.
+               */
+              return_url?: string;
+            }
+
+            namespace AccountOnboarding {
+              interface CollectionOptions {
+                /**
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 */
+                fields?: CollectionOptions.Fields;
+
+                /**
+                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
+                 */
+                future_requirements?: CollectionOptions.FutureRequirements;
+              }
+
+              namespace CollectionOptions {
+                type Fields = 'currently_due' | 'eventually_due';
+
+                type FutureRequirements = 'include' | 'omit';
+              }
+
+              type Configuration =
+                | 'customer'
+                | 'merchant'
+                | 'recipient'
+                | 'storer';
+            }
+
+            interface AccountUpdate {
+              /**
+               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
+               */
+              collection_options?: AccountUpdate.CollectionOptions;
+
+              /**
+               * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
+               */
+              configurations: Array<AccountUpdate.Configuration>;
+
+              /**
+               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
+               */
+              refresh_url: string;
+
+              /**
+               * The URL that the user will be redirected to upon completing the linked flow.
+               */
+              return_url?: string;
+            }
+
+            namespace AccountUpdate {
+              interface CollectionOptions {
+                /**
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 */
+                fields?: CollectionOptions.Fields;
+
+                /**
+                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
+                 */
+                future_requirements?: CollectionOptions.FutureRequirements;
+              }
+
+              namespace CollectionOptions {
+                type Fields = 'currently_due' | 'eventually_due';
+
+                type FutureRequirements = 'include' | 'omit';
+              }
+
+              type Configuration =
+                | 'customer'
+                | 'merchant'
+                | 'recipient'
+                | 'storer';
+            }
+
+            type Type = 'account_onboarding' | 'account_update';
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Core/AccountLinksResource.d.ts

@@ -0,0 +1,152 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        interface AccountLinkCreateParams {
+          /**
+           * The ID of the Account to create link for.
+           */
+          account: string;
+
+          /**
+           * The use case of the AccountLink.
+           */
+          use_case: AccountLinkCreateParams.UseCase;
+        }
+
+        namespace AccountLinkCreateParams {
+          interface UseCase {
+            /**
+             * Open Enum. The type of AccountLink the user is requesting.
+             */
+            type: UseCase.Type;
+
+            /**
+             * Indicates that the AccountLink provided should onboard an account.
+             */
+            account_onboarding?: UseCase.AccountOnboarding;
+
+            /**
+             * Indicates that the AccountLink provided should update a previously onboarded account.
+             */
+            account_update?: UseCase.AccountUpdate;
+          }
+
+          namespace UseCase {
+            interface AccountOnboarding {
+              /**
+               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
+               */
+              collection_options?: AccountOnboarding.CollectionOptions;
+
+              /**
+               * Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
+               */
+              configurations: Array<AccountOnboarding.Configuration>;
+
+              /**
+               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
+               */
+              refresh_url: string;
+
+              /**
+               * The URL that the user will be redirected to upon completing the linked flow.
+               */
+              return_url?: string;
+            }
+
+            namespace AccountOnboarding {
+              interface CollectionOptions {
+                /**
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 */
+                fields?: CollectionOptions.Fields;
+
+                /**
+                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
+                 */
+                future_requirements?: CollectionOptions.FutureRequirements;
+              }
+
+              namespace CollectionOptions {
+                type Fields = 'currently_due' | 'eventually_due';
+
+                type FutureRequirements = 'include' | 'omit';
+              }
+
+              type Configuration =
+                | 'customer'
+                | 'merchant'
+                | 'recipient'
+                | 'storer';
+            }
+
+            interface AccountUpdate {
+              /**
+               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
+               */
+              collection_options?: AccountUpdate.CollectionOptions;
+
+              /**
+               * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
+               */
+              configurations: Array<AccountUpdate.Configuration>;
+
+              /**
+               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
+               */
+              refresh_url: string;
+
+              /**
+               * The URL that the user will be redirected to upon completing the linked flow.
+               */
+              return_url?: string;
+            }
+
+            namespace AccountUpdate {
+              interface CollectionOptions {
+                /**
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 */
+                fields?: CollectionOptions.Fields;
+
+                /**
+                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
+                 */
+                future_requirements?: CollectionOptions.FutureRequirements;
+              }
+
+              namespace CollectionOptions {
+                type Fields = 'currently_due' | 'eventually_due';
+
+                type FutureRequirements = 'include' | 'omit';
+              }
+
+              type Configuration =
+                | 'customer'
+                | 'merchant'
+                | 'recipient'
+                | 'storer';
+            }
+
+            type Type = 'account_onboarding' | 'account_update';
+          }
+        }
+      }
+
+      namespace Core {
+        class AccountLinksResource {
+          /**
+           * Creates an AccountLink object that includes a single-use Stripe URL that the merchant can redirect their user to in order to take them to a Stripe-hosted application such as Recipient Onboarding.
+           */
+          create(
+            params: AccountLinkCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Core.AccountLink>>;
+        }
+      }
+    }
+  }
+}