diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 8d6382a9..b1917833 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v1626 \ No newline at end of file +v1627 \ No newline at end of file diff --git a/lib/stripe/resources/invoice.rb b/lib/stripe/resources/invoice.rb index 02564c0e..459a22ca 100644 --- a/lib/stripe/resources/invoice.rb +++ b/lib/stripe/resources/invoice.rb @@ -236,31 +236,32 @@ module Stripe class Parent < Stripe::StripeObject class QuoteDetails < Stripe::StripeObject - # Attribute for field quote + # The quote that generated this invoice attr_reader :quote end class SubscriptionDetails < Stripe::StripeObject class PauseCollection < Stripe::StripeObject - # Attribute for field behavior + # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. attr_reader :behavior - # Attribute for field resumes_at + # The time after which the subscription will resume collecting payments. attr_reader :resumes_at end - # Attribute for field metadata + # 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. + # *Note: This attribute is populated only for invoices created on or after June 29, 2023.* attr_reader :metadata - # Attribute for field pause_collection + # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). attr_reader :pause_collection - # Attribute for field subscription + # The subscription that generated this invoice attr_reader :subscription - # Attribute for field subscription_proration_date + # Only set for upcoming invoices that preview prorations. The time used to calculate prorations. attr_reader :subscription_proration_date end - # Attribute for field quote_details + # Details about the quote that generated this invoice attr_reader :quote_details - # Attribute for field subscription_details + # Details about the subscription that generated this invoice attr_reader :subscription_details - # Attribute for field type + # The type of parent that generated this invoice attr_reader :type end diff --git a/lib/stripe/resources/invoice_item.rb b/lib/stripe/resources/invoice_item.rb index 946a3d66..d20ae56e 100644 --- a/lib/stripe/resources/invoice_item.rb +++ b/lib/stripe/resources/invoice_item.rb @@ -26,14 +26,14 @@ module Stripe class Parent < Stripe::StripeObject class SubscriptionDetails < Stripe::StripeObject - # Attribute for field subscription + # The subscription that generated this invoice item attr_reader :subscription - # Attribute for field subscription_item + # The subscription item that generated this invoice item attr_reader :subscription_item end - # Attribute for field subscription_details + # Details about the subscription that generated this invoice item attr_reader :subscription_details - # Attribute for field type + # The type of parent that generated this invoice item attr_reader :type end diff --git a/lib/stripe/resources/invoice_line_item.rb b/lib/stripe/resources/invoice_line_item.rb index 1a6e30be..b06633ee 100644 --- a/lib/stripe/resources/invoice_line_item.rb +++ b/lib/stripe/resources/invoice_line_item.rb @@ -39,13 +39,13 @@ module Stripe # For a credit proration `line_item`, the original debit line_items to which the credit proration applies. attr_reader :credited_items end - # Attribute for field invoice_item + # The invoice item that generated this line item attr_reader :invoice_item - # Whether this is a proration. + # Whether this is a proration attr_reader :proration # Additional details for proration line items attr_reader :proration_details - # Attribute for field subscription + # The subscription that the invoice item belongs to attr_reader :subscription end @@ -60,22 +60,22 @@ module Stripe # For a credit proration `line_item`, the original debit line_items to which the credit proration applies. attr_reader :credited_items end - # Attribute for field invoice_item + # The invoice item that generated this line item attr_reader :invoice_item - # Whether this is a proration. + # Whether this is a proration attr_reader :proration # Additional details for proration line items attr_reader :proration_details - # Attribute for field subscription + # The subscription that the subscription item belongs to attr_reader :subscription - # Attribute for field subscription_item + # The subscription item that generated this line item attr_reader :subscription_item end - # Attribute for field invoice_item_details + # Details about the invoice item that generated this line item attr_reader :invoice_item_details - # Attribute for field subscription_item_details + # Details about the subscription item that generated this line item attr_reader :subscription_item_details - # Attribute for field type + # The type of parent that generated this line item attr_reader :type end diff --git a/lib/stripe/resources/quote_preview_invoice.rb b/lib/stripe/resources/quote_preview_invoice.rb index c1ec270a..ab961060 100644 --- a/lib/stripe/resources/quote_preview_invoice.rb +++ b/lib/stripe/resources/quote_preview_invoice.rb @@ -235,31 +235,32 @@ module Stripe class Parent < Stripe::StripeObject class QuoteDetails < Stripe::StripeObject - # Attribute for field quote + # The quote that generated this invoice attr_reader :quote end class SubscriptionDetails < Stripe::StripeObject class PauseCollection < Stripe::StripeObject - # Attribute for field behavior + # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. attr_reader :behavior - # Attribute for field resumes_at + # The time after which the subscription will resume collecting payments. attr_reader :resumes_at end - # Attribute for field metadata + # 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. + # *Note: This attribute is populated only for invoices created on or after June 29, 2023.* attr_reader :metadata - # Attribute for field pause_collection + # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). attr_reader :pause_collection - # Attribute for field subscription + # The subscription that generated this invoice attr_reader :subscription - # Attribute for field subscription_proration_date + # Only set for upcoming invoices that preview prorations. The time used to calculate prorations. attr_reader :subscription_proration_date end - # Attribute for field quote_details + # Details about the quote that generated this invoice attr_reader :quote_details - # Attribute for field subscription_details + # Details about the subscription that generated this invoice attr_reader :subscription_details - # Attribute for field type + # The type of parent that generated this invoice attr_reader :type end diff --git a/rbi/stripe/resources/invoice.rbi b/rbi/stripe/resources/invoice.rbi index 260f7440..45401c57 100644 --- a/rbi/stripe/resources/invoice.rbi +++ b/rbi/stripe/resources/invoice.rbi @@ -270,39 +270,40 @@ module Stripe end class Parent < Stripe::StripeObject class QuoteDetails < Stripe::StripeObject - # Attribute for field quote + # The quote that generated this invoice sig { returns(String) } attr_reader :quote end class SubscriptionDetails < Stripe::StripeObject class PauseCollection < Stripe::StripeObject - # Attribute for field behavior + # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. sig { returns(T.nilable(String)) } attr_reader :behavior - # Attribute for field resumes_at + # The time after which the subscription will resume collecting payments. sig { returns(T.nilable(Integer)) } attr_reader :resumes_at end - # Attribute for field metadata + # 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. + # *Note: This attribute is populated only for invoices created on or after June 29, 2023.* sig { returns(T.nilable(T::Hash[String, String])) } attr_reader :metadata - # Attribute for field pause_collection + # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). sig { returns(T.nilable(PauseCollection)) } attr_reader :pause_collection - # Attribute for field subscription + # The subscription that generated this invoice sig { returns(String) } attr_reader :subscription - # Attribute for field subscription_proration_date + # Only set for upcoming invoices that preview prorations. The time used to calculate prorations. sig { returns(Integer) } attr_reader :subscription_proration_date end - # Attribute for field quote_details + # Details about the quote that generated this invoice sig { returns(T.nilable(QuoteDetails)) } attr_reader :quote_details - # Attribute for field subscription_details + # Details about the subscription that generated this invoice sig { returns(T.nilable(SubscriptionDetails)) } attr_reader :subscription_details - # Attribute for field type + # The type of parent that generated this invoice sig { returns(String) } attr_reader :type end diff --git a/rbi/stripe/resources/invoice_item.rbi b/rbi/stripe/resources/invoice_item.rbi index e763fda7..70fe0785 100644 --- a/rbi/stripe/resources/invoice_item.rbi +++ b/rbi/stripe/resources/invoice_item.rbi @@ -17,17 +17,17 @@ module Stripe class InvoiceItem < APIResource class Parent < Stripe::StripeObject class SubscriptionDetails < Stripe::StripeObject - # Attribute for field subscription + # The subscription that generated this invoice item sig { returns(String) } attr_reader :subscription - # Attribute for field subscription_item + # The subscription item that generated this invoice item sig { returns(String) } attr_reader :subscription_item end - # Attribute for field subscription_details + # Details about the subscription that generated this invoice item sig { returns(T.nilable(SubscriptionDetails)) } attr_reader :subscription_details - # Attribute for field type + # The type of parent that generated this invoice item sig { returns(String) } attr_reader :type end diff --git a/rbi/stripe/resources/invoice_line_item.rbi b/rbi/stripe/resources/invoice_line_item.rbi index 74940a83..8803fa3e 100644 --- a/rbi/stripe/resources/invoice_line_item.rbi +++ b/rbi/stripe/resources/invoice_line_item.rbi @@ -38,16 +38,16 @@ module Stripe sig { returns(T.nilable(CreditedItems)) } attr_reader :credited_items end - # Attribute for field invoice_item + # The invoice item that generated this line item sig { returns(String) } attr_reader :invoice_item - # Whether this is a proration. + # Whether this is a proration sig { returns(T::Boolean) } attr_reader :proration # Additional details for proration line items sig { returns(T.nilable(ProrationDetails)) } attr_reader :proration_details - # Attribute for field subscription + # The subscription that the invoice item belongs to sig { returns(T.nilable(String)) } attr_reader :subscription end @@ -65,29 +65,29 @@ module Stripe sig { returns(T.nilable(CreditedItems)) } attr_reader :credited_items end - # Attribute for field invoice_item + # The invoice item that generated this line item sig { returns(T.nilable(String)) } attr_reader :invoice_item - # Whether this is a proration. + # Whether this is a proration sig { returns(T::Boolean) } attr_reader :proration # Additional details for proration line items sig { returns(T.nilable(ProrationDetails)) } attr_reader :proration_details - # Attribute for field subscription + # The subscription that the subscription item belongs to sig { returns(String) } attr_reader :subscription - # Attribute for field subscription_item + # The subscription item that generated this line item sig { returns(String) } attr_reader :subscription_item end - # Attribute for field invoice_item_details + # Details about the invoice item that generated this line item sig { returns(T.nilable(InvoiceItemDetails)) } attr_reader :invoice_item_details - # Attribute for field subscription_item_details + # Details about the subscription item that generated this line item sig { returns(T.nilable(SubscriptionItemDetails)) } attr_reader :subscription_item_details - # Attribute for field type + # The type of parent that generated this line item sig { returns(String) } attr_reader :type end diff --git a/rbi/stripe/resources/quote_preview_invoice.rbi b/rbi/stripe/resources/quote_preview_invoice.rbi index a89608e8..b8e61ddf 100644 --- a/rbi/stripe/resources/quote_preview_invoice.rbi +++ b/rbi/stripe/resources/quote_preview_invoice.rbi @@ -281,39 +281,40 @@ module Stripe end class Parent < Stripe::StripeObject class QuoteDetails < Stripe::StripeObject - # Attribute for field quote + # The quote that generated this invoice sig { returns(String) } attr_reader :quote end class SubscriptionDetails < Stripe::StripeObject class PauseCollection < Stripe::StripeObject - # Attribute for field behavior + # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. sig { returns(T.nilable(String)) } attr_reader :behavior - # Attribute for field resumes_at + # The time after which the subscription will resume collecting payments. sig { returns(T.nilable(Integer)) } attr_reader :resumes_at end - # Attribute for field metadata + # 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. + # *Note: This attribute is populated only for invoices created on or after June 29, 2023.* sig { returns(T.nilable(T::Hash[String, String])) } attr_reader :metadata - # Attribute for field pause_collection + # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). sig { returns(T.nilable(PauseCollection)) } attr_reader :pause_collection - # Attribute for field subscription + # The subscription that generated this invoice sig { returns(String) } attr_reader :subscription - # Attribute for field subscription_proration_date + # Only set for upcoming invoices that preview prorations. The time used to calculate prorations. sig { returns(Integer) } attr_reader :subscription_proration_date end - # Attribute for field quote_details + # Details about the quote that generated this invoice sig { returns(T.nilable(QuoteDetails)) } attr_reader :quote_details - # Attribute for field subscription_details + # Details about the subscription that generated this invoice sig { returns(T.nilable(SubscriptionDetails)) } attr_reader :subscription_details - # Attribute for field type + # The type of parent that generated this invoice sig { returns(String) } attr_reader :type end