Stripe::PhaseConfigurationParams
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
Constants
Constructors
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
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.
Custom attribute writer method checking allowed values (enum). @param [Object] add_invoice_items Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] application_fee_percent Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] automatic_tax Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] billing_cycle_anchor Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] billing_thresholds Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] collection_method Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] coupon Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] default_payment_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] default_tax_rates Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] discounts Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] end_date Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] invoice_settings Object to be assigned
List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
Custom attribute writer method checking allowed values (enum). @param [Object] items Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] iterations Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
The account on behalf of which to charge, for each of the associated subscription's invoices.
Custom attribute writer method checking allowed values (enum). @param [Object] on_behalf_of Object to be assigned
Whether the subscription schedule will create 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 parameter which controls what happens if the update request affects the billing configuration of the current phase.
Custom attribute writer method checking allowed values (enum). @param [Object] proration_behavior Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] start_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data Object to be assigned
If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
Custom attribute writer method checking allowed values (enum). @param [Object] trial Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] trial_end Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid