stripe 18.1.0.pre.beta.1 → 18.1.0

data/lib/stripe/params/application_fee_refund_create_params.rb

@@ -7,7 +7,7 @@ module Stripe
     attr_accessor :amount
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
-    # 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`.
+    # 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`.
     attr_accessor :metadata
 
     def initialize(amount: nil, expand: nil, metadata: nil)

data/lib/stripe/params/application_fee_refund_update_params.rb

@@ -5,7 +5,7 @@ module Stripe
   class ApplicationFeeRefundUpdateParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
-    # 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`.
+    # 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`.
     attr_accessor :metadata
 
     def initialize(expand: nil, metadata: nil)

data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb

@@ -37,9 +37,9 @@ module Stripe
           @type = type
         end
       end
-      # The customer for which to fetch credit balance summary.
+      # The customer whose credit balance summary you're retrieving.
       attr_accessor :customer
-      # The account for which to fetch credit balance summary.
+      # The account representing the customer whose credit balance summary you're retrieving.
       attr_accessor :customer_account
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand

data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb

@@ -6,9 +6,9 @@ module Stripe
     class CreditBalanceTransactionListParams < ::Stripe::RequestParams
       # The credit grant for which to fetch credit balance transactions.
       attr_accessor :credit_grant
-      # The customer for which to fetch credit balance transactions.
+      # The customer whose credit balance transactions you're retrieving.
       attr_accessor :customer
-      # The account for which to fetch credit balance transactions.
+      # The account representing the customer whose credit balance transactions you're retrieving.
       attr_accessor :customer_account
       # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
       attr_accessor :ending_before

data/lib/stripe/params/billing/credit_grant_create_params.rb

@@ -60,9 +60,9 @@ module Stripe
       attr_accessor :applicability_config
       # The category of this credit grant. It defaults to `paid` if not specified.
       attr_accessor :category
-      # ID of the customer to receive the billing credits.
+      # ID of the customer receiving the billing credits.
       attr_accessor :customer
-      # ID of the account to receive the billing credits.
+      # ID of the account representing the customer receiving the billing credits.
       attr_accessor :customer_account
       # The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
       attr_accessor :effective_at

data/lib/stripe/params/billing/credit_grant_list_params.rb

@@ -6,7 +6,7 @@ module Stripe
     class CreditGrantListParams < ::Stripe::RequestParams
       # Only return credit grants for this customer.
       attr_accessor :customer
-      # Only return credit grants for this account.
+      # Only return credit grants for this account representing the customer.
       attr_accessor :customer_account
       # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
       attr_accessor :ending_before

data/lib/stripe/params/billing/meter_event_create_params.rb

@@ -10,7 +10,7 @@ module Stripe
       attr_accessor :expand
       # A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
       attr_accessor :identifier
-      # The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+      # The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).
       attr_accessor :payload
       # The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
       attr_accessor :timestamp

data/lib/stripe/params/billing_portal/configuration_create_params.rb

@@ -128,6 +128,8 @@ module Stripe
               @conditions = conditions
             end
           end
+          # Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
+          attr_accessor :billing_cycle_anchor
           # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
           attr_accessor :default_allowed_updates
           # Whether the feature is enabled.
@@ -142,6 +144,7 @@ module Stripe
           attr_accessor :trial_update_behavior
 
           def initialize(
+            billing_cycle_anchor: nil,
             default_allowed_updates: nil,
             enabled: nil,
             products: nil,
@@ -149,6 +152,7 @@ module Stripe
             schedule_at_period_end: nil,
             trial_update_behavior: nil
           )
+            @billing_cycle_anchor = billing_cycle_anchor
             @default_allowed_updates = default_allowed_updates
             @enabled = enabled
             @products = products
@@ -184,7 +188,7 @@ module Stripe
       end
 
       class LoginPage < ::Stripe::RequestParams
-        # Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
+        # Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
         attr_accessor :enabled
 
         def initialize(enabled: nil)
@@ -193,7 +197,7 @@ module Stripe
       end
       # The business information shown to customers in the portal.
       attr_accessor :business_profile
-      # 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.
+      # 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://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
       attr_accessor :default_return_url
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
@@ -201,7 +205,7 @@ module Stripe
       attr_accessor :features
       # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
       attr_accessor :login_page
-      # 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`.
+      # 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`.
       attr_accessor :metadata
       # The name of the configuration.
       attr_accessor :name

data/lib/stripe/params/billing_portal/configuration_update_params.rb

@@ -128,6 +128,8 @@ module Stripe
               @conditions = conditions
             end
           end
+          # Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
+          attr_accessor :billing_cycle_anchor
           # The types of subscription updates that are supported. When empty, subscriptions are not updateable.
           attr_accessor :default_allowed_updates
           # Whether the feature is enabled.
@@ -142,6 +144,7 @@ module Stripe
           attr_accessor :trial_update_behavior
 
           def initialize(
+            billing_cycle_anchor: nil,
             default_allowed_updates: nil,
             enabled: nil,
             products: nil,
@@ -149,6 +152,7 @@ module Stripe
             schedule_at_period_end: nil,
             trial_update_behavior: nil
           )
+            @billing_cycle_anchor = billing_cycle_anchor
             @default_allowed_updates = default_allowed_updates
             @enabled = enabled
             @products = products
@@ -184,7 +188,7 @@ module Stripe
       end
 
       class LoginPage < ::Stripe::RequestParams
-        # Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
+        # Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
         #
         # Set to `false` to deactivate the `login_page.url`.
         attr_accessor :enabled
@@ -197,7 +201,7 @@ module Stripe
       attr_accessor :active
       # The business information shown to customers in the portal.
       attr_accessor :business_profile
-      # 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.
+      # 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://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
       attr_accessor :default_return_url
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
@@ -205,7 +209,7 @@ module Stripe
       attr_accessor :features
       # The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
       attr_accessor :login_page
-      # 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`.
+      # 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`.
       attr_accessor :metadata
       # The name of the configuration.
       attr_accessor :name

data/lib/stripe/params/billing_portal/session_create_params.rb

@@ -91,11 +91,11 @@ module Stripe
           end
 
           class Item < ::Stripe::RequestParams
-            # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+            # The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
             attr_accessor :id
-            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
             attr_accessor :price
-            # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+            # [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
             attr_accessor :quantity
 
             def initialize(id: nil, price: nil, quantity: nil)
@@ -106,7 +106,7 @@ module Stripe
           end
           # The coupon or promotion code to apply to this subscription update.
           attr_accessor :discounts
-          # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+          # The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
           attr_accessor :items
           # The ID of the subscription to be updated.
           attr_accessor :subscription
@@ -142,7 +142,7 @@ module Stripe
           @type = type
         end
       end
-      # The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
+      # The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
       attr_accessor :configuration
       # The ID of an existing customer.
       attr_accessor :customer
@@ -150,11 +150,11 @@ module Stripe
       attr_accessor :customer_account
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
-      # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
+      # Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
       attr_accessor :flow_data
       # The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
       attr_accessor :locale
-      # The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+      # The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
       attr_accessor :on_behalf_of
       # The default URL to redirect customers to when they click on the portal's link to return to your website.
       attr_accessor :return_url