class

Stripe::SubscriptionItem

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

Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [subscription_item]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_SUBSCRIPTION = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("subscription_item")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, billing_thresholds : Stripe::SubscriptionItemBillingThresholds1 | Nil = nil, created : Int64 | Nil = nil, discounts : Array(Stripe::InvoiceitemDiscountsInner) | Nil = nil, id : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, plan : Stripe::Plan | Nil = nil, price : Stripe::Price | Nil = nil, subscription : String | Nil = nil, tax_rates : Array(Stripe::TaxRate) | Nil = nil, quantity : Int64 | 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

billing_thresholds
Source
billing_thresholds=(new_value : Stripe::SubscriptionItemBillingThresholds1 | Nil)

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

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

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

Source
discounts

The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

Source
discounts=(new_value : Array(Stripe::InvoiceitemDiscountsInner) | Nil)

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

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id 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
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

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

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

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

Source
plan
Source
plan=(new_value : Stripe::Plan | Nil)

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

Source
price
Source
price=(new_value : Stripe::Price | Nil)

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

Source
quantity

The quantity of the plan to which the customer should be subscribed.

Source
quantity=(new_value : Int64 | Nil)

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

Source
subscription

The subscription this subscription_item belongs to.

Source
subscription=(new_value : String | Nil)

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

Source
tax_rates

The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item.

Source
tax_rates=(new_value : Array(Stripe::TaxRate) | Nil)

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