class Stripe::SubscriptionSchedulePhaseConfiguration

• Stripe::SubscriptionSchedulePhaseConfiguration
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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 : JSON::PullParser)
• .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

Instance Method Summary

• #==(other : self)

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

• #add_invoice_items : Array(Stripe::SubscriptionScheduleAddInvoiceItem) | Nil
• #add_invoice_items=(new_value : Array(Stripe::SubscriptionScheduleAddInvoiceItem) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application_fee_percent : Float64 | Nil
• #application_fee_percent=(new_value : Float64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #automatic_tax : Stripe::SchedulesPhaseAutomaticTax | Nil
• #automatic_tax=(new_value : Stripe::SchedulesPhaseAutomaticTax | Nil)

  Custom attribute writer method checking allowed values (enum).

• #billing_cycle_anchor : String | Nil
• #billing_cycle_anchor=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #billing_thresholds : Stripe::SubscriptionBillingThresholds1 | Nil
• #billing_thresholds=(new_value : Stripe::SubscriptionBillingThresholds1 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #collection_method : String | Nil
• #collection_method=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #coupon : Stripe::SubscriptionSchedulePhaseConfigurationCoupon | Nil
• #coupon=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationCoupon | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_payment_method : Stripe::SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod | Nil
• #default_payment_method=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_tax_rates : Array(Stripe::TaxRate) | Nil
• #default_tax_rates=(new_value : Array(Stripe::TaxRate) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_tax_rates_present=(default_tax_rates_present : Bool)
• #default_tax_rates_present? : Bool
• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #discounts : Array(Stripe::DiscountsResourceStackableDiscount) | Nil
• #discounts=(new_value : Array(Stripe::DiscountsResourceStackableDiscount) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #end_date : Int64 | Nil
• #end_date=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #invoice_settings : Stripe::SubscriptionSchedulePhaseConfigurationInvoiceSettings | Nil
• #invoice_settings=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationInvoiceSettings | Nil)

  Custom attribute writer method checking allowed values (enum).

• #items : Array(Stripe::SubscriptionScheduleConfigurationItem) | Nil
• #items=(new_value : Array(Stripe::SubscriptionScheduleConfigurationItem) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #on_behalf_of : Stripe::SubscriptionSchedulePhaseConfigurationOnBehalfOf | Nil
• #on_behalf_of=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationOnBehalfOf | Nil)

  Custom attribute writer method checking allowed values (enum).

• #proration_behavior : String | Nil
• #proration_behavior=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #start_date : Int64 | Nil
• #start_date=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transfer_data : Stripe::SubscriptionSchedulePhaseConfigurationTransferData | Nil
• #transfer_data=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationTransferData | Nil)

  Custom attribute writer method checking allowed values (enum).

• #trial_end : Int64 | Nil
• #trial_end=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail