Stripe::Subscription
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
Subscriptions allow you to charge a customer on a recurring basis. Related guide: Creating subscriptions
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
Custom attribute writer method checking allowed values (enum). @param [Object] application 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.
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
The reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
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_cycle_anchor_config Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] billing_thresholds Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] cancel_at Object to be assigned
Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.
Custom attribute writer method checking allowed values (enum). @param [Object] cancel_at_period_end Object to be assigned
If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
Custom attribute writer method checking allowed values (enum). @param [Object] canceled_at Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] cancellation_details Object to be assigned
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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.
Custom attribute writer method checking allowed values (enum). @param [Object] collection_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned
End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
Custom attribute writer method checking allowed values (enum). @param [Object] current_period_end Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] current_period_start Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned
Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
Custom attribute writer method checking allowed values (enum). @param [Object] days_until_due Object to be assigned
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_source Object to be assigned
The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.
Custom attribute writer method checking allowed values (enum). @param [Object] default_tax_rates Object to be assigned
The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
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] discount Object to be assigned
The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.
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] ended_at 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] id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] invoice_settings Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] items Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] latest_invoice Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
Custom attribute writer method checking allowed values (enum). @param [Object] next_pending_invoice_item_invoice Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] on_behalf_of Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pause_collection Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_settings Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pending_invoice_item_interval Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pending_setup_intent Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pending_update Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] schedule Object to be assigned
Date when the subscription was first created. The date might differ from the created date due to backdating.
Custom attribute writer method checking allowed values (enum). @param [Object] start_date Object to be assigned
Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused. For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active status. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal status, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is trialing and moves to active when the trial period is over. A subscription can only enter a paused status when a trial ends without a payment method. A paused subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The paused status is different from pausing collection, which still generates invoices and leaves the subscription's status unchanged. If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings). If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] test_clock Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] trial_end Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] trial_settings Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] trial_start Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid