class Stripe::PostSubscriptionsRequest

• Stripe::PostSubscriptionsRequest
• Reference
• Object

Included Modules

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

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_COLLECTION_METHOD = "invalid value for \"collection_method\", must be one of [charge_automatically, send_invoice]."

ERROR_MESSAGE_FOR_ON_BEHALF_OF = "invalid value for \"on_behalf_of\", must be one of []."

ERROR_MESSAGE_FOR_PAYMENT_BEHAVIOR = "invalid value for \"payment_behavior\", must be one of [allow_incomplete, default_incomplete, error_if_incomplete, pending_if_incomplete]."

ERROR_MESSAGE_FOR_PRORATION_BEHAVIOR = "invalid value for \"proration_behavior\", must be one of [always_invoice, create_prorations, none]."

MAX_LENGTH_FOR_COUPON = 5000

MAX_LENGTH_FOR_CUSTOMER = 5000

MAX_LENGTH_FOR_DEFAULT_PAYMENT_METHOD = 5000

MAX_LENGTH_FOR_DEFAULT_SOURCE = 5000

MAX_LENGTH_FOR_DESCRIPTION = 500

MAX_LENGTH_FOR_PROMOTION_CODE = 5000

VALID_VALUES_FOR_COLLECTION_METHOD = String.static_array("charge_automatically", "send_invoice")

VALID_VALUES_FOR_ON_BEHALF_OF = String.static_array("")

VALID_VALUES_FOR_PAYMENT_BEHAVIOR = String.static_array("allow_incomplete", "default_incomplete", "error_if_incomplete", "pending_if_incomplete")

VALID_VALUES_FOR_PRORATION_BEHAVIOR = String.static_array("always_invoice", "create_prorations", "none")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, customer : String | Nil = nil, add_invoice_items : Array(Stripe::AddInvoiceItemEntry) | Nil = nil, application_fee_percent : Stripe::PostSubscriptionsRequestApplicationFeePercent | Nil = nil, automatic_tax : Stripe::AutomaticTaxConfig | Nil = nil, backdate_start_date : Int64 | Nil = nil, billing_cycle_anchor : Int64 | Nil = nil, billing_cycle_anchor_config : Stripe::BillingCycleAnchorConfigParam | Nil = nil, billing_thresholds : Stripe::PostSubscriptionsRequestBillingThresholds | Nil = nil, cancel_at : Int64 | Nil = nil, cancel_at_period_end : Bool | Nil = nil, collection_method : String | Nil = nil, coupon : String | Nil = nil, currency : String | Nil = nil, days_until_due : Int64 | Nil = nil, default_payment_method : String | Nil = nil, default_source : String | Nil = nil, default_tax_rates : Stripe::PostSubscriptionsRequestDefaultTaxRates | Nil = nil, description : String | Nil = nil, discounts : Stripe::PostSubscriptionsRequestDiscounts | Nil = nil, expand : Array(String) | Nil = nil, invoice_settings : Stripe::InvoiceSettingsParam | Nil = nil, items : Array(Stripe::SubscriptionItemCreateParams) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, off_session : Bool | Nil = nil, on_behalf_of : String | Nil = nil, payment_behavior : String | Nil = nil, payment_settings : Stripe::PaymentSettings | Nil = nil, pending_invoice_item_interval : Stripe::PostSubscriptionsRequestPendingInvoiceItemInterval | Nil = nil, promotion_code : String | Nil = nil, proration_behavior : String | Nil = nil, transfer_data : Stripe::TransferDataSpecs | Nil = nil, trial_end : Stripe::PostSubscriptionsRequestTrialEnd | Nil = nil, trial_from_plan : Bool | Nil = nil, trial_period_days : Int64 | Nil = nil, trial_settings : Stripe::TrialSettingsConfig | 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::AddInvoiceItemEntry) | Nil
• #add_invoice_items=(new_value : Array(Stripe::AddInvoiceItemEntry) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application_fee_percent : Stripe::PostSubscriptionsRequestApplicationFeePercent | Nil
• #application_fee_percent=(new_value : Stripe::PostSubscriptionsRequestApplicationFeePercent | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #billing_cycle_anchor_config : Stripe::BillingCycleAnchorConfigParam | Nil
• #billing_cycle_anchor_config=(new_value : Stripe::BillingCycleAnchorConfigParam | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #cancel_at_period_end : Bool | Nil
• #cancel_at_period_end=(new_value : Bool | 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 : String | Nil
• #coupon=(new_value : String | 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).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #default_tax_rates : Stripe::PostSubscriptionsRequestDefaultTaxRates | Nil
• #default_tax_rates=(new_value : Stripe::PostSubscriptionsRequestDefaultTaxRates | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #discounts : Stripe::PostSubscriptionsRequestDiscounts | Nil
• #discounts=(new_value : Stripe::PostSubscriptionsRequestDiscounts | Nil)

  Custom attribute writer method checking allowed values (enum).

• #expand : Array(String) | Nil
• #expand=(new_value : Array(String) | 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::InvoiceSettingsParam | Nil
• #invoice_settings=(new_value : Stripe::InvoiceSettingsParam | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #metadata : Stripe::PostAccountsRequestMetadata | Nil
• #metadata=(new_value : Stripe::PostAccountsRequestMetadata | Nil)

  Custom attribute writer method checking allowed values (enum).

• #off_session : Bool | Nil
• #off_session=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #payment_settings : Stripe::PaymentSettings | Nil
• #payment_settings=(new_value : Stripe::PaymentSettings | Nil)

  Custom attribute writer method checking allowed values (enum).

• #pending_invoice_item_interval : Stripe::PostSubscriptionsRequestPendingInvoiceItemInterval | Nil
• #pending_invoice_item_interval=(new_value : Stripe::PostSubscriptionsRequestPendingInvoiceItemInterval | Nil)

  Custom attribute writer method checking allowed values (enum).

• #promotion_code : String | Nil
• #promotion_code=(new_value : String | 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).

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

  Custom attribute writer method checking allowed values (enum).

• #trial_end : Stripe::PostSubscriptionsRequestTrialEnd | Nil
• #trial_end=(new_value : Stripe::PostSubscriptionsRequestTrialEnd | Nil)

  Custom attribute writer method checking allowed values (enum).

• #trial_from_plan : Bool | Nil
• #trial_from_plan=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #trial_settings : Stripe::TrialSettingsConfig | Nil
• #trial_settings=(new_value : Stripe::TrialSettingsConfig | 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