Class: Stripe::SubscriptionSchedule::UpdateParams::Phase

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/subscription_schedule.rb

Defined Under Namespace

Classes: AddInvoiceItem, AutomaticTax, BillingThresholds, Discount, InvoiceSettings, Item, PauseCollection, TransferData, TrialSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, billing_thresholds: nil, collection_method: nil, coupon: nil, currency: nil, default_payment_method: nil, default_tax_rates: nil, description: nil, discounts: nil, end_date: nil, invoice_settings: nil, items: nil, iterations: nil, metadata: nil, on_behalf_of: nil, pause_collection: nil, proration_behavior: nil, start_date: nil, transfer_data: nil, trial: nil, trial_continuation: nil, trial_end: nil, trial_settings: nil) ⇒ Phase

Returns a new instance of Phase.



1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1945

def initialize(
  add_invoice_items: nil,
  application_fee_percent: nil,
  automatic_tax: nil,
  billing_cycle_anchor: nil,
  billing_thresholds: nil,
  collection_method: nil,
  coupon: nil,
  currency: nil,
  default_payment_method: nil,
  default_tax_rates: nil,
  description: nil,
  discounts: nil,
  end_date: nil,
  invoice_settings: nil,
  items: nil,
  iterations: nil,
  metadata: nil,
  on_behalf_of: nil,
  pause_collection: nil,
  proration_behavior: nil,
  start_date: nil,
  transfer_data: nil,
  trial: nil,
  trial_continuation: nil,
  trial_end: nil,
  trial_settings: nil
)
  @add_invoice_items = add_invoice_items
  @application_fee_percent = application_fee_percent
  @automatic_tax = automatic_tax
  @billing_cycle_anchor = billing_cycle_anchor
  @billing_thresholds = billing_thresholds
  @collection_method = collection_method
  @coupon = coupon
  @currency = currency
  @default_payment_method = default_payment_method
  @default_tax_rates = default_tax_rates
  @description = description
  @discounts = discounts
  @end_date = end_date
  @invoice_settings = invoice_settings
  @items = items
  @iterations = iterations
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @pause_collection = pause_collection
  @proration_behavior = proration_behavior
  @start_date = start_date
  @transfer_data = transfer_data
  @trial = trial
  @trial_continuation = trial_continuation
  @trial_end = trial_end
  @trial_settings = trial_settings
end

Instance Attribute Details

#add_invoice_items ⇒ Object

A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.



1868
1869
1870
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1868

def add_invoice_items
  @add_invoice_items
end

#application_fee_percent ⇒ Object

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).



1871
1872
1873
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1871

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Automatic tax settings for this phase.



1874
1875
1876
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1874

def automatic_tax
  @automatic_tax
end

#billing_cycle_anchor ⇒ Object

Can be set to ‘phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](stripe.com/docs/billing/subscriptions/billing-cycle).



1877
1878
1879
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1877

def billing_cycle_anchor
  @billing_cycle_anchor
end

#billing_thresholds ⇒ Object

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.



1880
1881
1882
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1880

def billing_thresholds
  @billing_thresholds
end

#collection_method ⇒ Object

Either ‘charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.



1883
1884
1885
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1883

def collection_method
  @collection_method
end

#coupon ⇒ Object

The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use ‘discounts` instead.



1886
1887
1888
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1886

def coupon
  @coupon
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



1889
1890
1891
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1889

def currency
  @currency
end

#default_payment_method ⇒ Object

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer’s invoice settings.



1892
1893
1894
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1892

def default_payment_method
  @default_payment_method
end

#default_tax_rates ⇒ Object

A list of [Tax Rate](stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription’s [‘default_tax_rates`](stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice’s [‘default_tax_rates`](stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.



1895
1896
1897
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1895

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.



1898
1899
1900
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1898

def description
  @description
end

#discounts ⇒ Object

The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription’s customer. Pass an empty string to avoid inheriting any discounts.



1901
1902
1903
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1901

def discounts
  @discounts
end

#end_date ⇒ Object

The date at which this phase of the subscription schedule ends. If set, ‘iterations` must not be set.



1904
1905
1906
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1904

def end_date
  @end_date
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



1907
1908
1909
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1907

def invoice_settings
  @invoice_settings
end

#items ⇒ Object

List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.



1910
1911
1912
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1910

def items
  @items
end

#iterations ⇒ Object

Integer representing the multiplier applied to the price interval. For example, ‘iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.



1913
1914
1915
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1913

def iterations
  @iterations
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule’s phase will update the underlying subscription’s ‘metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription’s ‘metadata`. Individual keys in the subscription’s ‘metadata` can be unset by posting an empty value to them in the phase’s ‘metadata`. To unset all keys in the subscription’s ‘metadata`, update the subscription directly or unset every key individually from the phase’s ‘metadata`.



1916
1917
1918
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1916

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge, for each of the associated subscription’s invoices.



1919
1920
1921
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1919

def on_behalf_of
  @on_behalf_of
end

#pause_collection ⇒ Object

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](stripe.com/docs/billing/subscriptions/pause-payment).



1922
1923
1924
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1922

def pause_collection
  @pause_collection
end

#proration_behavior ⇒ Object

Whether the subscription schedule will create [prorations](stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is ‘create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It’s different from the request-level [proration_behavior](stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.



1925
1926
1927
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1925

def proration_behavior
  @proration_behavior
end

#start_date ⇒ Object

The date at which this phase of the subscription schedule starts or ‘now`. Must be set on the first phase.



1928
1929
1930
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1928

def start_date
  @start_date
end

#transfer_data ⇒ Object

The data with which to automatically create a Transfer for each of the associated subscription’s invoices.



1931
1932
1933
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1931

def transfer_data
  @transfer_data
end

#trial ⇒ Object

If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.



1934
1935
1936
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1934

def trial
  @trial
end

#trial_continuation ⇒ Object

Specify trial behavior when crossing phase boundaries



1937
1938
1939
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1937

def trial_continuation
  @trial_continuation
end

#trial_end ⇒ Object

Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with ‘trial`



1940
1941
1942
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1940

def trial_end
  @trial_end
end

#trial_settings ⇒ Object

Settings related to subscription trials.



1943
1944
1945
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 1943

def trial_settings
  @trial_settings
end