class

Stripe::SubscriptionSchedulePhaseConfiguration

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.

Constants

ERROR_MESSAGE_FOR_BILLING_CYCLE_ANCHOR = "invalid value for \"billing_cycle_anchor\", must be one of [automatic, phase_start]."
ERROR_MESSAGE_FOR_COLLECTION_METHOD = "invalid value for \"collection_method\", must be one of [charge_automatically, send_invoice]."
ERROR_MESSAGE_FOR_PRORATION_BEHAVIOR = "invalid value for \"proration_behavior\", must be one of [always_invoice, create_prorations, none]."
MAX_LENGTH_FOR_DESCRIPTION = 5000
VALID_VALUES_FOR_BILLING_CYCLE_ANCHOR = String.static_array("automatic", "phase_start")
VALID_VALUES_FOR_COLLECTION_METHOD = String.static_array("charge_automatically", "send_invoice")
VALID_VALUES_FOR_PRORATION_BEHAVIOR = String.static_array("always_invoice", "create_prorations", "none")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, add_invoice_items : Array(Stripe::SubscriptionScheduleAddInvoiceItem) | Nil = nil, application_fee_percent : Float64 | Nil = nil, billing_cycle_anchor : String | Nil = nil, billing_thresholds : Stripe::SubscriptionBillingThresholds1 | Nil = nil, collection_method : String | Nil = nil, coupon : Stripe::SubscriptionSchedulePhaseConfigurationCoupon | Nil = nil, currency : String | Nil = nil, default_payment_method : Stripe::SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod | Nil = nil, description : String | Nil = nil, discounts : Array(Stripe::DiscountsResourceStackableDiscount) | Nil = nil, end_date : Int64 | Nil = nil, invoice_settings : Stripe::SubscriptionSchedulePhaseConfigurationInvoiceSettings | Nil = nil, items : Array(Stripe::SubscriptionScheduleConfigurationItem) | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : Stripe::SubscriptionSchedulePhaseConfigurationOnBehalfOf | Nil = nil, proration_behavior : String | Nil = nil, start_date : Int64 | Nil = nil, transfer_data : Stripe::SubscriptionSchedulePhaseConfigurationTransferData | Nil = nil, trial_end : Int64 | Nil = nil, automatic_tax : Stripe::SchedulesPhaseAutomaticTax | Nil = nil, default_tax_rates : Array(Stripe::TaxRate) | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

add_invoice_items

A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.

Source
add_invoice_items=(new_value : Array(Stripe::SubscriptionScheduleAddInvoiceItem) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] add_invoice_items Object to be assigned

Source
application_fee_percent

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 during this phase of the schedule.

Source
application_fee_percent=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] application_fee_percent Object to be assigned

Source
automatic_tax
Source
automatic_tax=(new_value : Stripe::SchedulesPhaseAutomaticTax | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] automatic_tax Object to be assigned

Source
billing_cycle_anchor

Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.

Source
billing_cycle_anchor=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] billing_cycle_anchor Object to be assigned

Source
billing_thresholds
Source
billing_thresholds=(new_value : Stripe::SubscriptionBillingThresholds1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] billing_thresholds Object to be assigned

Source
collection_method

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.

Source
collection_method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] collection_method Object to be assigned

Source
coupon
Source

Custom attribute writer method checking allowed values (enum). @param [Object] coupon Object to be assigned

Source
currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Source
currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source
default_payment_method
Source

Custom attribute writer method checking allowed values (enum). @param [Object] default_payment_method Object to be assigned

Source
default_tax_rates

The default tax rates to apply to the subscription during this phase of the subscription schedule.

Source
default_tax_rates=(new_value : Array(Stripe::TaxRate) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] default_tax_rates Object to be assigned

Source
default_tax_rates_present=(default_tax_rates_present : Bool)
Source
default_tax_rates_present?
Source
description

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.

Source
description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

Source
discounts

The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.

Source
discounts=(new_value : Array(Stripe::DiscountsResourceStackableDiscount) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] discounts Object to be assigned

Source
end_date

The end of this phase of the subscription schedule.

Source
end_date=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] end_date Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

invoice_settings
Source

Custom attribute writer method checking allowed values (enum). @param [Object] invoice_settings Object to be assigned

Source
items

Subscription items to configure the subscription to during this phase of the subscription schedule.

Source

Custom attribute writer method checking allowed values (enum). @param [Object] items Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
on_behalf_of
Source

Custom attribute writer method checking allowed values (enum). @param [Object] on_behalf_of Object to be assigned

Source
proration_behavior

If the subscription schedule will prorate when transitioning to this phase. Possible values are create_prorations and none.

Source
proration_behavior=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] proration_behavior Object to be assigned

Source
start_date

The start of this phase of the subscription schedule.

Source
start_date=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] start_date Object to be assigned

Source
transfer_data
Source

Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data Object to be assigned

Source
trial_end

When the trial ends within the phase.

Source
trial_end=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] trial_end Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source