class Stripe::InvoiceSubscription

• Stripe::InvoiceSubscription
• Reference
• Object

Overview

The subscription that this invoice was prepared for, if any.

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_OBJECT = "invalid value for \"object\", must be one of [subscription]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [active, canceled, incomplete, incomplete_expired, past_due, paused, trialing, unpaid]."

MAX_LENGTH_FOR_DESCRIPTION = 500

MAX_LENGTH_FOR_ID = 5000

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

VALID_VALUES_FOR_OBJECT = String.static_array("subscription")

VALID_VALUES_FOR_STATUS = String.static_array("active", "canceled", "incomplete", "incomplete_expired", "past_due", "paused", "trialing", "unpaid")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, application : Stripe::SubscriptionApplication | Nil = nil, application_fee_percent : Float64 | Nil = nil, automatic_tax : Stripe::SubscriptionAutomaticTax | Nil = nil, billing_cycle_anchor : Int64 | Nil = nil, billing_cycle_anchor_config : Stripe::SubscriptionsResourceBillingCycleAnchorConfig | Nil = nil, billing_thresholds : Stripe::SubscriptionBillingThresholds | Nil = nil, cancel_at : Int64 | Nil = nil, cancel_at_period_end : Bool | Nil = nil, canceled_at : Int64 | Nil = nil, cancellation_details : Stripe::CancellationDetails | Nil = nil, collection_method : String | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, current_period_end : Int64 | Nil = nil, current_period_start : Int64 | Nil = nil, customer : Stripe::SubscriptionCustomer | Nil = nil, days_until_due : Int64 | Nil = nil, default_payment_method : Stripe::SubscriptionDefaultPaymentMethod | Nil = nil, default_source : Stripe::SubscriptionDefaultSource | Nil = nil, description : String | Nil = nil, discount : Stripe::Discount | Nil = nil, discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil = nil, ended_at : Int64 | Nil = nil, id : String | Nil = nil, invoice_settings : Stripe::SubscriptionsResourceSubscriptionInvoiceSettings | Nil = nil, items : Stripe::SubscriptionItemList | Nil = nil, latest_invoice : Stripe::SubscriptionLatestInvoice | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, next_pending_invoice_item_invoice : Int64 | Nil = nil, object : String | Nil = nil, on_behalf_of : Stripe::SubscriptionOnBehalfOf | Nil = nil, pause_collection : Stripe::SubscriptionsResourcePauseCollection | Nil = nil, payment_settings : Stripe::SubscriptionsResourcePaymentSettings | Nil = nil, pending_invoice_item_interval : Stripe::SubscriptionPendingInvoiceItemInterval | Nil = nil, pending_setup_intent : Stripe::SubscriptionPendingSetupIntent | Nil = nil, pending_update : Stripe::SubscriptionsResourcePendingUpdate | Nil = nil, schedule : Stripe::SubscriptionSchedule1 | Nil = nil, start_date : Int64 | Nil = nil, status : String | Nil = nil, test_clock : Stripe::SubscriptionTestClock | Nil = nil, transfer_data : Stripe::SubscriptionTransferData | Nil = nil, trial_end : Int64 | Nil = nil, trial_settings : Stripe::SubscriptionsTrialsResourceTrialSettings | Nil = nil, trial_start : Int64 | Nil = nil, default_tax_rates : Array(Stripe::TaxRate) | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Class Method Summary

• .openapi_any_of

  List of class defined in anyOf (OpenAPI v3)

Instance Method Summary

• #==(other : self)

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

• #application : Stripe::SubscriptionApplication | Nil
• #application=(application : Stripe::SubscriptionApplication | Nil)
• #application_fee_percent : Float64 | Nil
• #application_fee_percent=(application_fee_percent : Float64 | Nil)
• #automatic_tax : Stripe::SubscriptionAutomaticTax | Nil
• #automatic_tax=(automatic_tax : Stripe::SubscriptionAutomaticTax | Nil)
• #billing_cycle_anchor : Int64 | Nil
• #billing_cycle_anchor=(billing_cycle_anchor : Int64 | Nil)
• #billing_cycle_anchor_config : Stripe::SubscriptionsResourceBillingCycleAnchorConfig | Nil
• #billing_cycle_anchor_config=(billing_cycle_anchor_config : Stripe::SubscriptionsResourceBillingCycleAnchorConfig | Nil)
• #billing_thresholds : Stripe::SubscriptionBillingThresholds | Nil
• #billing_thresholds=(billing_thresholds : Stripe::SubscriptionBillingThresholds | Nil)
• #cancel_at : Int64 | Nil
• #cancel_at=(cancel_at : Int64 | Nil)
• #cancel_at_period_end : Bool | Nil
• #cancel_at_period_end=(cancel_at_period_end : Bool | Nil)
• #canceled_at : Int64 | Nil
• #canceled_at=(canceled_at : Int64 | Nil)
• #cancellation_details : Stripe::CancellationDetails | Nil
• #cancellation_details=(cancellation_details : Stripe::CancellationDetails | Nil)
• #collection_method : String | Nil
• #collection_method=(collection_method : String | Nil)
• #created : Int64 | Nil
• #created=(created : Int64 | Nil)
• #currency : String | Nil
• #currency=(currency : String | Nil)
• #current_period_end : Int64 | Nil
• #current_period_end=(current_period_end : Int64 | Nil)
• #current_period_start : Int64 | Nil
• #current_period_start=(current_period_start : Int64 | Nil)
• #customer : Stripe::SubscriptionCustomer | Nil
• #customer=(customer : Stripe::SubscriptionCustomer | Nil)
• #days_until_due : Int64 | Nil
• #days_until_due=(days_until_due : Int64 | Nil)
• #default_payment_method : Stripe::SubscriptionDefaultPaymentMethod | Nil
• #default_payment_method=(default_payment_method : Stripe::SubscriptionDefaultPaymentMethod | Nil)
• #default_source : Stripe::SubscriptionDefaultSource | Nil
• #default_source=(default_source : Stripe::SubscriptionDefaultSource | Nil)
• #default_tax_rates : Array(Stripe::TaxRate) | Nil
• #default_tax_rates=(default_tax_rates : Array(Stripe::TaxRate) | Nil)
• #default_tax_rates_present=(default_tax_rates_present : Bool)
• #default_tax_rates_present? : Bool
• #description : String | Nil
• #description=(description : String | Nil)
• #discount : Stripe::Discount | Nil
• #discount=(discount : Stripe::Discount | Nil)
• #discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil
• #discounts=(discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil)
• #ended_at : Int64 | Nil
• #ended_at=(ended_at : Int64 | Nil)
• #hash(hasher)

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

• #id : String | Nil
• #id=(id : String | Nil)
• #invoice_settings : Stripe::SubscriptionsResourceSubscriptionInvoiceSettings | Nil
• #invoice_settings=(invoice_settings : Stripe::SubscriptionsResourceSubscriptionInvoiceSettings | Nil)
• #items : Stripe::SubscriptionItemList | Nil
• #items=(items : Stripe::SubscriptionItemList | Nil)
• #latest_invoice : Stripe::SubscriptionLatestInvoice | Nil
• #latest_invoice=(latest_invoice : Stripe::SubscriptionLatestInvoice | Nil)
• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(livemode : Bool | Nil)
• #metadata : Hash(String, String) | Nil
• #metadata=(metadata : Hash(String, String) | Nil)
• #next_pending_invoice_item_invoice : Int64 | Nil
• #next_pending_invoice_item_invoice=(next_pending_invoice_item_invoice : Int64 | Nil)
• #object : String | Nil
• #object=(object : String | Nil)
• #on_behalf_of : Stripe::SubscriptionOnBehalfOf | Nil
• #on_behalf_of=(on_behalf_of : Stripe::SubscriptionOnBehalfOf | Nil)
• #pause_collection : Stripe::SubscriptionsResourcePauseCollection | Nil
• #pause_collection=(pause_collection : Stripe::SubscriptionsResourcePauseCollection | Nil)
• #payment_settings : Stripe::SubscriptionsResourcePaymentSettings | Nil
• #payment_settings=(payment_settings : Stripe::SubscriptionsResourcePaymentSettings | Nil)
• #pending_invoice_item_interval : Stripe::SubscriptionPendingInvoiceItemInterval | Nil
• #pending_invoice_item_interval=(pending_invoice_item_interval : Stripe::SubscriptionPendingInvoiceItemInterval | Nil)
• #pending_setup_intent : Stripe::SubscriptionPendingSetupIntent | Nil
• #pending_setup_intent=(pending_setup_intent : Stripe::SubscriptionPendingSetupIntent | Nil)
• #pending_update : Stripe::SubscriptionsResourcePendingUpdate | Nil
• #pending_update=(pending_update : Stripe::SubscriptionsResourcePendingUpdate | Nil)
• #schedule : Stripe::SubscriptionSchedule1 | Nil
• #schedule=(schedule : Stripe::SubscriptionSchedule1 | Nil)
• #start_date : Int64 | Nil
• #start_date=(start_date : Int64 | Nil)
• #status : String | Nil
• #status=(status : String | Nil)
• #test_clock : Stripe::SubscriptionTestClock | Nil
• #test_clock=(test_clock : Stripe::SubscriptionTestClock | Nil)
• #transfer_data : Stripe::SubscriptionTransferData | Nil
• #transfer_data=(transfer_data : Stripe::SubscriptionTransferData | Nil)
• #trial_end : Int64 | Nil
• #trial_end=(trial_end : Int64 | Nil)
• #trial_settings : Stripe::SubscriptionsTrialsResourceTrialSettings | Nil
• #trial_settings=(trial_settings : Stripe::SubscriptionsTrialsResourceTrialSettings | Nil)
• #trial_start : Int64 | Nil
• #trial_start=(trial_start : Int64 | Nil)
• #valid? : Bool

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

Constructor Detail

Class Method Detail

Instance Method Detail