class

Stripe::DefaultSettingsParams

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

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]."
MAX_LENGTH_FOR_DEFAULT_PAYMENT_METHOD = 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")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, application_fee_percent : Float64 | Nil = nil, automatic_tax : Stripe::AutomaticTaxConfig | Nil = nil, billing_cycle_anchor : String | Nil = nil, billing_thresholds : Stripe::PostSubscriptionsRequestBillingThresholds | Nil = nil, collection_method : String | Nil = nil, default_payment_method : String | Nil = nil, description : Stripe::DefaultSettingsParamsDescription | Nil = nil, invoice_settings : Stripe::SubscriptionScheduleDefaultSettingsParam | Nil = nil, on_behalf_of : Stripe::DefaultSettingsParamsOnBehalfOf | Nil = nil, transfer_data : Stripe::DefaultSettingsParamsTransferData | 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

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. 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.

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::AutomaticTaxConfig | Nil)

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

Source
billing_cycle_anchor

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.

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::PostSubscriptionsRequestBillingThresholds | 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. Defaults to charge_automatically on creation.

Source
collection_method=(new_value : String | Nil)

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

Source
default_payment_method

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.

Source
default_payment_method=(new_value : String | Nil)

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

Source
description
Source
description=(new_value : Stripe::DefaultSettingsParamsDescription | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description 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
invoice_settings=(new_value : Stripe::SubscriptionScheduleDefaultSettingsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] invoice_settings 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
on_behalf_of
Source
on_behalf_of=(new_value : Stripe::DefaultSettingsParamsOnBehalfOf | Nil)

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

Source
transfer_data
Source
transfer_data=(new_value : Stripe::DefaultSettingsParamsTransferData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data 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