stripe 13.2.0 → 13.3.0.pre.beta.2

data/lib/stripe/resources/subscription_schedule.rb

@@ -15,6 +15,179 @@ module Stripe
       "subscription_schedule"
     end
 
+    class CurrentPhase < Stripe::StripeObject
+      attr_reader :end_date, :start_date
+    end
+
+    class DefaultSettings < Stripe::StripeObject
+      class AutomaticTax < Stripe::StripeObject
+        class Liability < Stripe::StripeObject
+          attr_reader :account, :type
+        end
+        attr_reader :disabled_reason, :enabled, :liability
+      end
+
+      class BillingThresholds < Stripe::StripeObject
+        attr_reader :amount_gte, :reset_billing_cycle_anchor
+      end
+
+      class InvoiceSettings < Stripe::StripeObject
+        class Issuer < Stripe::StripeObject
+          attr_reader :account, :type
+        end
+        attr_reader :account_tax_ids, :days_until_due, :issuer
+      end
+
+      class TransferData < Stripe::StripeObject
+        attr_reader :amount_percent, :destination
+      end
+      attr_reader :application_fee_percent, :automatic_tax, :billing_cycle_anchor, :billing_thresholds, :collection_method, :default_payment_method, :description, :invoice_settings, :on_behalf_of, :transfer_data
+    end
+
+    class LastPriceMigrationError < Stripe::StripeObject
+      class FailedTransition < Stripe::StripeObject
+        attr_reader :source_price, :target_price
+      end
+      attr_reader :errored_at, :failed_transitions, :type
+    end
+
+    class Phase < Stripe::StripeObject
+      class AddInvoiceItem < Stripe::StripeObject
+        class Discount < Stripe::StripeObject
+          class DiscountEnd < Stripe::StripeObject
+            attr_reader :timestamp, :type
+          end
+          attr_reader :coupon, :discount, :discount_end, :promotion_code
+        end
+        attr_reader :discounts, :price, :quantity, :tax_rates
+      end
+
+      class AutomaticTax < Stripe::StripeObject
+        class Liability < Stripe::StripeObject
+          attr_reader :account, :type
+        end
+        attr_reader :disabled_reason, :enabled, :liability
+      end
+
+      class BillingThresholds < Stripe::StripeObject
+        attr_reader :amount_gte, :reset_billing_cycle_anchor
+      end
+
+      class Discount < Stripe::StripeObject
+        class DiscountEnd < Stripe::StripeObject
+          attr_reader :timestamp, :type
+        end
+        attr_reader :coupon, :discount, :discount_end, :promotion_code
+      end
+
+      class InvoiceSettings < Stripe::StripeObject
+        class Issuer < Stripe::StripeObject
+          attr_reader :account, :type
+        end
+        attr_reader :account_tax_ids, :days_until_due, :issuer
+      end
+
+      class Item < Stripe::StripeObject
+        class BillingThresholds < Stripe::StripeObject
+          attr_reader :usage_gte
+        end
+
+        class Discount < Stripe::StripeObject
+          class DiscountEnd < Stripe::StripeObject
+            attr_reader :timestamp, :type
+          end
+          attr_reader :coupon, :discount, :discount_end, :promotion_code
+        end
+
+        class Trial < Stripe::StripeObject
+          attr_reader :converts_to, :type
+        end
+        attr_reader :billing_thresholds, :discounts, :metadata, :plan, :price, :quantity, :tax_rates, :trial
+      end
+
+      class PauseCollection < Stripe::StripeObject
+        attr_reader :behavior
+      end
+
+      class TransferData < Stripe::StripeObject
+        attr_reader :amount_percent, :destination
+      end
+
+      class TrialSettings < Stripe::StripeObject
+        class EndBehavior < Stripe::StripeObject
+          attr_reader :prorate_up_front
+        end
+        attr_reader :end_behavior
+      end
+      attr_reader :add_invoice_items, :application_fee_percent, :automatic_tax, :billing_cycle_anchor, :billing_thresholds, :collection_method, :coupon, :currency, :default_payment_method, :default_tax_rates, :description, :discounts, :end_date, :invoice_settings, :items, :metadata, :on_behalf_of, :pause_collection, :proration_behavior, :start_date, :transfer_data, :trial_continuation, :trial_end, :trial_settings
+    end
+
+    class Prebilling < Stripe::StripeObject
+      attr_reader :invoice, :period_end, :period_start, :update_behavior
+    end
+    # ID of the Connect Application that created the schedule.
+    attr_reader :application
+    # Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
+    attr_reader :billing_behavior
+    # Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
+    attr_reader :canceled_at
+    # Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
+    attr_reader :completed_at
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
+    attr_reader :current_phase
+    # ID of the customer who owns the subscription schedule.
+    attr_reader :customer
+    # Attribute for field default_settings
+    attr_reader :default_settings
+    # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
+    attr_reader :end_behavior
+    # Unique identifier for the object.
+    attr_reader :id
+    # Details of the most recent price migration that failed for the subscription schedule.
+    attr_reader :last_price_migration_error
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # 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.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Configuration for the subscription schedule's phases.
+    attr_reader :phases
+    # Time period and invoice for a Subscription billed in advance.
+    attr_reader :prebilling
+    # Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
+    attr_reader :released_at
+    # ID of the subscription once managed by the subscription schedule (if it is released).
+    attr_reader :released_subscription
+    # The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
+    attr_reader :status
+    # ID of the subscription managed by the subscription schedule.
+    attr_reader :subscription
+    # ID of the test clock this subscription schedule belongs to.
+    attr_reader :test_clock
+
+    # Amends an existing subscription schedule.
+    def amend(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Amends an existing subscription schedule.
+    def self.amend(schedule, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
     def cancel(params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources/tax/association.rb

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
+    class Association < APIResource
+      OBJECT_NAME = "tax.association"
+      def self.object_name
+        "tax.association"
+      end
+
+      class StatusDetails < Stripe::StripeObject
+        class Committed < Stripe::StripeObject
+          class Reversal < Stripe::StripeObject
+            class StatusDetails < Stripe::StripeObject
+              class Committed < Stripe::StripeObject
+                attr_reader :transaction
+              end
+
+              class Errored < Stripe::StripeObject
+                attr_reader :reason, :refund_id
+              end
+              attr_reader :committed, :errored
+            end
+            attr_reader :status, :status_details
+          end
+          attr_reader :reversals, :transaction
+        end
+
+        class Errored < Stripe::StripeObject
+          attr_reader :reason
+        end
+        attr_reader :committed, :errored
+      end
+      # The [Tax Calculation](https://stripe.com/docs/api/tax/calculations/object) that was included in PaymentIntent.
+      attr_reader :calculation
+      # Unique identifier for the object.
+      attr_reader :id
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) that this Tax Association is tracking.
+      attr_reader :payment_intent
+      # Status of the Tax Association.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
+
+      # Finds a tax association object by PaymentIntent id.
+      def self.find(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/tax/associations/find",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/tax/calculation.rb

@@ -14,6 +14,78 @@ module Stripe
         "tax.calculation"
       end
 
+      class CustomerDetails < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          attr_reader :city, :country, :line1, :line2, :postal_code, :state
+        end
+
+        class TaxId < Stripe::StripeObject
+          attr_reader :type, :value
+        end
+        attr_reader :address, :address_source, :ip_address, :tax_ids, :taxability_override
+      end
+
+      class ShipFromDetails < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          attr_reader :city, :country, :line1, :line2, :postal_code, :state
+        end
+        attr_reader :address
+      end
+
+      class ShippingCost < Stripe::StripeObject
+        class TaxBreakdown < Stripe::StripeObject
+          class Jurisdiction < Stripe::StripeObject
+            attr_reader :country, :display_name, :level, :state
+          end
+
+          class TaxRateDetails < Stripe::StripeObject
+            attr_reader :display_name, :percentage_decimal, :tax_type
+          end
+          attr_reader :amount, :jurisdiction, :sourcing, :tax_rate_details, :taxability_reason, :taxable_amount
+        end
+        attr_reader :amount, :amount_tax, :shipping_rate, :tax_behavior, :tax_breakdown, :tax_code
+      end
+
+      class TaxBreakdown < Stripe::StripeObject
+        class TaxRateDetails < Stripe::StripeObject
+          class FlatAmount < Stripe::StripeObject
+            attr_reader :amount, :currency
+          end
+          attr_reader :country, :flat_amount, :percentage_decimal, :rate_type, :state, :tax_type
+        end
+        attr_reader :amount, :inclusive, :tax_rate_details, :taxability_reason, :taxable_amount
+      end
+      # Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+      attr_reader :amount_total
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.
+      attr_reader :customer
+      # Attribute for field customer_details
+      attr_reader :customer_details
+      # Timestamp of date at which the tax calculation will expire.
+      attr_reader :expires_at
+      # Unique identifier for the calculation.
+      attr_reader :id
+      # The list of items the customer is purchasing.
+      attr_reader :line_items
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The details of the ship from location, such as the address.
+      attr_reader :ship_from_details
+      # The shipping cost details for the calculation.
+      attr_reader :shipping_cost
+      # The amount of tax to be collected on top of the line item prices.
+      attr_reader :tax_amount_exclusive
+      # The amount of tax already included in the line item prices.
+      attr_reader :tax_amount_inclusive
+      # Breakdown of individual tax amounts that add up to the total.
+      attr_reader :tax_breakdown
+      # Timestamp of date at which the tax rules and rates in effect applies for the calculation.
+      attr_reader :tax_date
+
       # Calculates tax based on the input and returns a Tax Calculation object.
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/tax/calculation_line_item.rb

@@ -8,6 +8,39 @@ module Stripe
       def self.object_name
         "tax.calculation_line_item"
       end
+
+      class TaxBreakdown < Stripe::StripeObject
+        class Jurisdiction < Stripe::StripeObject
+          attr_reader :country, :display_name, :level, :state
+        end
+
+        class TaxRateDetails < Stripe::StripeObject
+          attr_reader :display_name, :percentage_decimal, :tax_type
+        end
+        attr_reader :amount, :jurisdiction, :sourcing, :tax_rate_details, :taxability_reason, :taxable_amount
+      end
+      # The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
+      attr_reader :amount
+      # The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+      attr_reader :amount_tax
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ID of an existing [Product](https://stripe.com/docs/api/products/object).
+      attr_reader :product
+      # The number of units of the item being purchased. For reversals, this is the quantity reversed.
+      attr_reader :quantity
+      # A custom identifier for this line item.
+      attr_reader :reference
+      # Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
+      attr_reader :tax_behavior
+      # Detailed account of taxes relevant to this line item.
+      attr_reader :tax_breakdown
+      # The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.
+      attr_reader :tax_code
     end
   end
 end

data/lib/stripe/resources/tax/form.rb

@@ -0,0 +1,124 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
+    #
+    # Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
+    class Form < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "tax.form"
+      def self.object_name
+        "tax.form"
+      end
+
+      class AuSerr < Stripe::StripeObject
+        attr_reader :reporting_period_end_date, :reporting_period_start_date
+      end
+
+      class CaMrdp < Stripe::StripeObject
+        attr_reader :reporting_period_end_date, :reporting_period_start_date
+      end
+
+      class EuDac7 < Stripe::StripeObject
+        attr_reader :reporting_period_end_date, :reporting_period_start_date
+      end
+
+      class FilingStatus < Stripe::StripeObject
+        class Jurisdiction < Stripe::StripeObject
+          attr_reader :country, :level, :state
+        end
+        attr_reader :effective_at, :jurisdiction, :value
+      end
+
+      class GbMrdp < Stripe::StripeObject
+        attr_reader :reporting_period_end_date, :reporting_period_start_date
+      end
+
+      class NzMrdp < Stripe::StripeObject
+        attr_reader :reporting_period_end_date, :reporting_period_start_date
+      end
+
+      class Payee < Stripe::StripeObject
+        attr_reader :account, :external_reference, :type
+      end
+
+      class Us1099K < Stripe::StripeObject
+        attr_reader :reporting_year
+      end
+
+      class Us1099Misc < Stripe::StripeObject
+        attr_reader :reporting_year
+      end
+
+      class Us1099Nec < Stripe::StripeObject
+        attr_reader :reporting_year
+      end
+      # Attribute for field au_serr
+      attr_reader :au_serr
+      # Attribute for field ca_mrdp
+      attr_reader :ca_mrdp
+      # The form that corrects this form, if any.
+      attr_reader :corrected_by
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Attribute for field eu_dac7
+      attr_reader :eu_dac7
+      # A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction’s tax authority.
+      attr_reader :filing_statuses
+      # Attribute for field gb_mrdp
+      attr_reader :gb_mrdp
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # Attribute for field nz_mrdp
+      attr_reader :nz_mrdp
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Attribute for field payee
+      attr_reader :payee
+      # The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
+      attr_reader :type
+      # Attribute for field us_1099_k
+      attr_reader :us_1099_k
+      # Attribute for field us_1099_misc
+      attr_reader :us_1099_misc
+      # Attribute for field us_1099_nec
+      attr_reader :us_1099_nec
+
+      # Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/tax/forms", params: filters, opts: opts)
+      end
+
+      # Download the PDF for a tax form.
+      def pdf(params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        request_stream(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts,
+          base_address: :files,
+          &read_body_chunk_block
+        )
+      end
+
+      # Download the PDF for a tax form.
+      def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        execute_resource_request_stream(
+          :get,
+          format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
+          :files,
+          params,
+          opts,
+          &read_body_chunk_block
+        )
+      end
+    end
+  end
+end