class Stripe::SubscriptionSchedulePhaseConfiguration

Overview

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

Included Modules

Defined in:

stripe/models/subscription_schedule_phase_configuration.cr

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def add_invoice_items : Array(Stripe::SubscriptionScheduleAddInvoiceItem) | Nil #

[View source]
def 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


[View source]
def application_fee_percent : Float64 | Nil #

[View source]
def application_fee_percent=(new_value : Float64 | Nil) #

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


[View source]
def automatic_tax : Stripe::SchedulesPhaseAutomaticTax | Nil #

[View source]
def automatic_tax=(new_value : Stripe::SchedulesPhaseAutomaticTax | Nil) #

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


[View source]
def billing_cycle_anchor : String | Nil #

[View source]
def billing_cycle_anchor=(new_value : String | Nil) #

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


[View source]
def billing_thresholds : Stripe::SubscriptionBillingThresholds1 | Nil #

[View source]
def billing_thresholds=(new_value : Stripe::SubscriptionBillingThresholds1 | Nil) #

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


[View source]
def collection_method : String | Nil #

[View source]
def collection_method=(new_value : String | Nil) #

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


[View source]

[View source]

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


[View source]
def currency : String | Nil #

[View source]
def currency=(new_value : String | Nil) #

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


[View source]

[View source]
def default_payment_method=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationDefaultPaymentMethod | Nil) #

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


[View source]
def default_tax_rates : Array(Stripe::TaxRate) | Nil #

[View source]
def 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


[View source]
def default_tax_rates_present=(default_tax_rates_present : Bool) #

[View source]
def default_tax_rates_present? : Bool #

[View source]
def description : String | Nil #

[View source]
def description=(new_value : String | Nil) #

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


[View source]
def discounts : Array(Stripe::DiscountsResourceStackableDiscount) | Nil #

[View source]
def discounts=(new_value : Array(Stripe::DiscountsResourceStackableDiscount) | Nil) #

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


[View source]
def end_date : Int64 | Nil #

[View source]
def end_date=(new_value : Int64 | Nil) #

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


[View source]
def hash(hasher) #

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



[View source]
def invoice_settings=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationInvoiceSettings | Nil) #

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


[View source]

[View source]
def items=(new_value : Array(Stripe::SubscriptionScheduleConfigurationItem) | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

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


[View source]

[View source]
def on_behalf_of=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationOnBehalfOf | Nil) #

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


[View source]
def proration_behavior : String | Nil #

[View source]
def proration_behavior=(new_value : String | Nil) #

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


[View source]
def start_date : Int64 | Nil #

[View source]
def start_date=(new_value : Int64 | Nil) #

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


[View source]

[View source]
def transfer_data=(new_value : Stripe::SubscriptionSchedulePhaseConfigurationTransferData | Nil) #

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


[View source]
def trial_end : Int64 | Nil #

[View source]
def trial_end=(new_value : Int64 | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]