sharpetronics/stripe-ruby
1
0
Fork 0
mirror of https://github.com/stripe/stripe-ruby.git synced 2025-10-08 00:02:46 -04:00
Code Issues Projects Releases Wiki Activity
stripe-ruby/lib/stripe/resources/subscription_schedule.rb
Stripe OpenAPI 5a7339d7d5 Update generated code for v1641
2025-03-31 14:16:15 +00:00

2367 lines
124 KiB
Ruby
Raw Blame History

# File generated from our OpenAPI spec
# frozen_string_literal: true
module Stripe
# A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
#
# Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)
class SubscriptionSchedule < APIResource
extend Stripe::APIOperations::Create
extend Stripe::APIOperations::List
include Stripe::APIOperations::Save
OBJECT_NAME = "subscription_schedule"
def self.object_name
"subscription_schedule"
end
class CurrentPhase < Stripe::StripeObject
# The end of this phase of the subscription schedule.
attr_reader :end_date
# The start of this phase of the subscription schedule.
attr_reader :start_date
end
class DefaultSettings < Stripe::StripeObject
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
attr_reader :account
# Type of the account referenced.
attr_reader :type
end
# If Stripe disabled automatic tax, this enum describes why.
attr_reader :disabled_reason
# Whether Stripe automatically computes tax on invoices created during this phase.
attr_reader :enabled
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
attr_reader :liability
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
attr_reader :account
# Type of the account referenced.
attr_reader :type
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
attr_reader :account_tax_ids
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
attr_reader :days_until_due
# Attribute for field issuer
attr_reader :issuer
end
class TransferData < Stripe::StripeObject
# 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 destination account. By default, the entire amount is transferred to the destination.
attr_reader :amount_percent
# The account where funds from the payment will be transferred to upon payment success.
attr_reader :destination
end
# 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 during this phase of the schedule.
attr_reader :application_fee_percent
# Attribute for field automatic_tax
attr_reader :automatic_tax
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
attr_reader :billing_cycle_anchor
# 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`.
attr_reader :collection_method
# ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
attr_reader :default_payment_method
# Subscription 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.
attr_reader :description
# Attribute for field invoice_settings
attr_reader :invoice_settings
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
attr_reader :on_behalf_of
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
attr_reader :transfer_data
end
class LastPriceMigrationError < Stripe::StripeObject
class FailedTransition < Stripe::StripeObject
# The original price to be migrated.
attr_reader :source_price
# The intended resulting price of the migration.
attr_reader :target_price
end
# The time at which the price migration encountered an error.
attr_reader :errored_at
# The involved price pairs in each failed transition.
attr_reader :failed_transitions
# The type of error encountered by the price migration.
attr_reader :type
end
class Phase < Stripe::StripeObject
class AddInvoiceItem < Stripe::StripeObject
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
attr_reader :timestamp
# The discount end type.
attr_reader :type
end
# ID of the coupon to create a new discount for.
attr_reader :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_reader :discount
# Details to determine how long the discount should be applied for.
attr_reader :discount_end
# ID of the promotion code to create a new discount for.
attr_reader :promotion_code
end
# The stackable discounts that will be applied to the item.
attr_reader :discounts
# ID of the price used to generate the invoice item.
attr_reader :price
# The quantity of the invoice item.
attr_reader :quantity
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
attr_reader :tax_rates
end
class AutomaticTax < Stripe::StripeObject
class Liability < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
attr_reader :account
# Type of the account referenced.
attr_reader :type
end
# If Stripe disabled automatic tax, this enum describes why.
attr_reader :disabled_reason
# Whether Stripe automatically computes tax on invoices created during this phase.
attr_reader :enabled
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
attr_reader :liability
end
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
attr_reader :timestamp
# The discount end type.
attr_reader :type
end
# ID of the coupon to create a new discount for.
attr_reader :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_reader :discount
# Details to determine how long the discount should be applied for.
attr_reader :discount_end
# ID of the promotion code to create a new discount for.
attr_reader :promotion_code
end
class InvoiceSettings < Stripe::StripeObject
class Issuer < Stripe::StripeObject
# The connected account being referenced when `type` is `account`.
attr_reader :account
# Type of the account referenced.
attr_reader :type
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
attr_reader :account_tax_ids
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
attr_reader :days_until_due
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
attr_reader :issuer
end
class Item < Stripe::StripeObject
class Discount < Stripe::StripeObject
class DiscountEnd < Stripe::StripeObject
# The discount end timestamp.
attr_reader :timestamp
# The discount end type.
attr_reader :type
end
# ID of the coupon to create a new discount for.
attr_reader :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_reader :discount
# Details to determine how long the discount should be applied for.
attr_reader :discount_end
# ID of the promotion code to create a new discount for.
attr_reader :promotion_code
end
class Trial < Stripe::StripeObject
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
attr_reader :converts_to
# Determines the type of trial for this item.
attr_reader :type
end
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
attr_reader :discounts
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
attr_reader :metadata
# ID of the plan to which the customer should be subscribed.
attr_reader :plan
# ID of the price to which the customer should be subscribed.
attr_reader :price
# Quantity of the plan to which the customer should be subscribed.
attr_reader :quantity
# The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
attr_reader :tax_rates
# Options that configure the trial on the subscription item.
attr_reader :trial
end
class PauseCollection < Stripe::StripeObject
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
attr_reader :behavior
end
class TransferData < Stripe::StripeObject
# 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 destination account. By default, the entire amount is transferred to the destination.
attr_reader :amount_percent
# The account where funds from the payment will be transferred to upon payment success.
attr_reader :destination
end
class TrialSettings < Stripe::StripeObject
class EndBehavior < Stripe::StripeObject
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
attr_reader :prorate_up_front
end
# Defines how the subscription should behave when a trial ends.
attr_reader :end_behavior
end
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
attr_reader :add_invoice_items
# 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 during this phase of the schedule.
attr_reader :application_fee_percent
# Attribute for field automatic_tax
attr_reader :automatic_tax
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
attr_reader :billing_cycle_anchor
# 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`.
attr_reader :collection_method
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_reader :currency
# 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.
attr_reader :default_payment_method
# The default tax rates to apply to the subscription during this phase of the subscription schedule.
attr_reader :default_tax_rates
# Subscription 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.
attr_reader :description
# The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
attr_reader :discounts
# The end of this phase of the subscription schedule.
attr_reader :end_date
# The invoice settings applicable during this phase.
attr_reader :invoice_settings
# Subscription items to configure the subscription to during this phase of the subscription schedule.
attr_reader :items
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
attr_reader :metadata
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
attr_reader :on_behalf_of
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
attr_reader :pause_collection
# If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.
attr_reader :proration_behavior
# The start of this phase of the subscription schedule.
attr_reader :start_date
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
attr_reader :transfer_data
# Specify behavior of the trial when crossing schedule phase boundaries
attr_reader :trial_continuation
# When the trial ends within the phase.
attr_reader :trial_end
# Settings related to any trials on the subscription during this phase.
attr_reader :trial_settings
end
class Prebilling < Stripe::StripeObject
# ID of the prebilling invoice.
attr_reader :invoice
# The end of the last period for which the invoice pre-bills.
attr_reader :period_end
# The start of the first period for which the invoice pre-bills.
attr_reader :period_start
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
attr_reader :update_behavior
end
class ListParams < Stripe::RequestParams
class CanceledAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
attr_accessor :gt
# Minimum value to filter by (inclusive)
attr_accessor :gte
# Maximum value to filter by (exclusive)
attr_accessor :lt
# Maximum value to filter by (inclusive)
attr_accessor :lte
def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
@gt = gt
@gte = gte
@lt = lt
@lte = lte
end
end
class CompletedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
attr_accessor :gt
# Minimum value to filter by (inclusive)
attr_accessor :gte
# Maximum value to filter by (exclusive)
attr_accessor :lt
# Maximum value to filter by (inclusive)
attr_accessor :lte
def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
@gt = gt
@gte = gte
@lt = lt
@lte = lte
end
end
class Created < Stripe::RequestParams
# Minimum value to filter by (exclusive)
attr_accessor :gt
# Minimum value to filter by (inclusive)
attr_accessor :gte
# Maximum value to filter by (exclusive)
attr_accessor :lt
# Maximum value to filter by (inclusive)
attr_accessor :lte
def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
@gt = gt
@gte = gte
@lt = lt
@lte = lte
end
end
class ReleasedAt < Stripe::RequestParams
# Minimum value to filter by (exclusive)
attr_accessor :gt
# Minimum value to filter by (inclusive)
attr_accessor :gte
# Maximum value to filter by (exclusive)
attr_accessor :lt
# Maximum value to filter by (inclusive)
attr_accessor :lte
def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
@gt = gt
@gte = gte
@lt = lt
@lte = lte
end
end
# Only return subscription schedules that were created canceled the given date interval.
attr_accessor :canceled_at
# Only return subscription schedules that completed during the given date interval.
attr_accessor :completed_at
# Only return subscription schedules that were created during the given date interval.
attr_accessor :created
# Only return subscription schedules for the given customer.
attr_accessor :customer
# Only return subscription schedules for the given account.
attr_accessor :customer_account
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
attr_accessor :ending_before
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
attr_accessor :limit
# Only return subscription schedules that were released during the given date interval.
attr_accessor :released_at
# Only return subscription schedules that have not started yet.
attr_accessor :scheduled
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
attr_accessor :starting_after
def initialize(
canceled_at: nil,
completed_at: nil,
created: nil,
customer: nil,
customer_account: nil,
ending_before: nil,
expand: nil,
limit: nil,
released_at: nil,
scheduled: nil,
starting_after: nil
)
@canceled_at = canceled_at
@completed_at = completed_at
@created = created
@customer = customer
@customer_account = customer_account
@ending_before = ending_before
@expand = expand
@limit = limit
@released_at = released_at
@scheduled = scheduled
@starting_after = starting_after
end
end
class CreateParams < Stripe::RequestParams
class DefaultSettings < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
attr_accessor :enabled
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
attr_accessor :liability
def initialize(enabled: nil, liability: nil)
@enabled = enabled
@liability = liability
end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
attr_accessor :account_tax_ids
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
attr_accessor :days_until_due
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
attr_accessor :issuer
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil)
@account_tax_ids = account_tax_ids
@days_until_due = days_until_due
@issuer = issuer
end
end
class TransferData < Stripe::RequestParams
# 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 destination account. By default, the entire amount is transferred to the destination.
attr_accessor :amount_percent
# ID of an existing, connected Stripe account.
attr_accessor :destination
def initialize(amount_percent: nil, destination: nil)
@amount_percent = amount_percent
@destination = destination
end
end
# 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](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
attr_accessor :application_fee_percent
# Default settings for automatic tax computation.
attr_accessor :automatic_tax
# 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](https://stripe.com/docs/billing/subscriptions/billing-cycle).
attr_accessor :billing_cycle_anchor
# 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.
attr_accessor :collection_method
# 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.
attr_accessor :default_payment_method
# Subscription 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.
attr_accessor :description
# All invoices will be billed using the specified settings.
attr_accessor :invoice_settings
# The account on behalf of which to charge, for each of the associated subscription's invoices.
attr_accessor :on_behalf_of
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
attr_accessor :transfer_data
def initialize(
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
collection_method: nil,
default_payment_method: nil,
description: nil,
invoice_settings: nil,
on_behalf_of: nil,
transfer_data: nil
)
@application_fee_percent = application_fee_percent
@automatic_tax = automatic_tax
@billing_cycle_anchor = billing_cycle_anchor
@collection_method = collection_method
@default_payment_method = default_payment_method
@description = description
@invoice_settings = invoice_settings
@on_behalf_of = on_behalf_of
@transfer_data = transfer_data
end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class PriceData < Stripe::RequestParams
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
attr_accessor :product
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
attr_accessor :tax_behavior
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
attr_accessor :unit_amount
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
attr_accessor :unit_amount_decimal
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
)
@currency = currency
@product = product
@tax_behavior = tax_behavior
@unit_amount = unit_amount
@unit_amount_decimal = unit_amount_decimal
end
end
# The coupons to redeem into discounts for the item.
attr_accessor :discounts
# The ID of the price object. One of `price` or `price_data` is required.
attr_accessor :price
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
attr_accessor :price_data
# Quantity for this item. Defaults to 1.
attr_accessor :quantity
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
attr_accessor :tax_rates
def initialize(discounts: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil)
@discounts = discounts
@price = price
@price_data = price_data
@quantity = quantity
@tax_rates = tax_rates
end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
attr_accessor :enabled
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
attr_accessor :liability
def initialize(enabled: nil, liability: nil)
@enabled = enabled
@liability = liability
end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
attr_accessor :account_tax_ids
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
attr_accessor :days_until_due
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
attr_accessor :issuer
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil)
@account_tax_ids = account_tax_ids
@days_until_due = days_until_due
@issuer = issuer
end
end
class Item < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
attr_accessor :product
# The recurring components of a price such as `interval` and `interval_count`.
attr_accessor :recurring
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
attr_accessor :tax_behavior
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
attr_accessor :unit_amount
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
attr_accessor :unit_amount_decimal
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
)
@currency = currency
@product = product
@recurring = recurring
@tax_behavior = tax_behavior
@unit_amount = unit_amount
@unit_amount_decimal = unit_amount_decimal
end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
attr_accessor :converts_to
# Determines the type of trial for this item.
attr_accessor :type
def initialize(converts_to: nil, type: nil)
@converts_to = converts_to
@type = type
end
end
# The coupons to redeem into discounts for the subscription item.
attr_accessor :discounts
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
attr_accessor :metadata
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
attr_accessor :plan
# The ID of the price object.
attr_accessor :price
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
attr_accessor :price_data
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
attr_accessor :quantity
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
attr_accessor :tax_rates
# Options that configure the trial on the subscription item.
attr_accessor :trial
def initialize(
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
)
@discounts = discounts
@metadata = metadata
@plan = plan
@price = price
@price_data = price_data
@quantity = quantity
@tax_rates = tax_rates
@trial = trial
end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
attr_accessor :behavior
def initialize(behavior: nil)
@behavior = behavior
end
end
class TransferData < Stripe::RequestParams
# 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 destination account. By default, the entire amount is transferred to the destination.
attr_accessor :amount_percent
# ID of an existing, connected Stripe account.
attr_accessor :destination
def initialize(amount_percent: nil, destination: nil)
@amount_percent = amount_percent
@destination = destination
end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
attr_accessor :prorate_up_front
def initialize(prorate_up_front: nil)
@prorate_up_front = prorate_up_front
end
end
# Defines how the subscription should behave when a trial ends.
attr_accessor :end_behavior
def initialize(end_behavior: nil)
@end_behavior = end_behavior
end
end
# 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.
attr_accessor :add_invoice_items
# 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](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
attr_accessor :application_fee_percent
# Automatic tax settings for this phase.
attr_accessor :automatic_tax
# 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](https://stripe.com/docs/billing/subscriptions/billing-cycle).
attr_accessor :billing_cycle_anchor
# 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.
attr_accessor :collection_method
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# 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.
attr_accessor :default_payment_method
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
attr_accessor :default_tax_rates
# Subscription 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.
attr_accessor :description
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
attr_accessor :discounts
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
attr_accessor :end_date
# All invoices will be billed using the specified settings.
attr_accessor :invoice_settings
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
attr_accessor :items
# 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.
attr_accessor :iterations
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
attr_accessor :metadata
# The account on behalf of which to charge, for each of the associated subscription's invoices.
attr_accessor :on_behalf_of
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
attr_accessor :pause_collection
# Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/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](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
attr_accessor :proration_behavior
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
attr_accessor :transfer_data
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
attr_accessor :trial
# Specify trial behavior when crossing phase boundaries
attr_accessor :trial_continuation
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
attr_accessor :trial_end
# Settings related to subscription trials.
attr_accessor :trial_settings
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
iterations: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
)
@add_invoice_items = add_invoice_items
@application_fee_percent = application_fee_percent
@automatic_tax = automatic_tax
@billing_cycle_anchor = billing_cycle_anchor
@collection_method = collection_method
@currency = currency
@default_payment_method = default_payment_method
@default_tax_rates = default_tax_rates
@description = description
@discounts = discounts
@end_date = end_date
@invoice_settings = invoice_settings
@items = items
@iterations = iterations
@metadata = metadata
@on_behalf_of = on_behalf_of
@pause_collection = pause_collection
@proration_behavior = proration_behavior
@transfer_data = transfer_data
@trial = trial
@trial_continuation = trial_continuation
@trial_end = trial_end
@trial_settings = trial_settings
end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
attr_accessor :iterations
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
attr_accessor :update_behavior
def initialize(iterations: nil, update_behavior: nil)
@iterations = iterations
@update_behavior = update_behavior
end
end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
attr_accessor :billing_behavior
# The identifier of the customer to create the subscription schedule for.
attr_accessor :customer
# The identifier of the account to create the subscription schedule for.
attr_accessor :customer_account
# Object representing the subscription schedule's default settings.
attr_accessor :default_settings
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
attr_accessor :end_behavior
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
attr_accessor :from_subscription
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
attr_accessor :phases
# If specified, the invoicing for the given billing cycle iterations will be processed now.
attr_accessor :prebilling
# When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
attr_accessor :start_date
def initialize(
billing_behavior: nil,
customer: nil,
customer_account: nil,
default_settings: nil,
end_behavior: nil,
expand: nil,
from_subscription: nil,
metadata: nil,
phases: nil,
prebilling: nil,
start_date: nil
)
@billing_behavior = billing_behavior
@customer = customer
@customer_account = customer_account
@default_settings = default_settings
@end_behavior = end_behavior
@expand = expand
@from_subscription = from_subscription
@metadata = metadata
@phases = phases
@prebilling = prebilling
@start_date = start_date
end
end
class UpdateParams < Stripe::RequestParams
class DefaultSettings < Stripe::RequestParams
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
attr_accessor :enabled
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
attr_accessor :liability
def initialize(enabled: nil, liability: nil)
@enabled = enabled
@liability = liability
end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
attr_accessor :account_tax_ids
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
attr_accessor :days_until_due
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
attr_accessor :issuer
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil)
@account_tax_ids = account_tax_ids
@days_until_due = days_until_due
@issuer = issuer
end
end
class TransferData < Stripe::RequestParams
# 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 destination account. By default, the entire amount is transferred to the destination.
attr_accessor :amount_percent
# ID of an existing, connected Stripe account.
attr_accessor :destination
def initialize(amount_percent: nil, destination: nil)
@amount_percent = amount_percent
@destination = destination
end
end
# 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](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
attr_accessor :application_fee_percent
# Default settings for automatic tax computation.
attr_accessor :automatic_tax
# 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](https://stripe.com/docs/billing/subscriptions/billing-cycle).
attr_accessor :billing_cycle_anchor
# 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.
attr_accessor :collection_method
# 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.
attr_accessor :default_payment_method
# Subscription 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.
attr_accessor :description
# All invoices will be billed using the specified settings.
attr_accessor :invoice_settings
# The account on behalf of which to charge, for each of the associated subscription's invoices.
attr_accessor :on_behalf_of
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
attr_accessor :transfer_data
def initialize(
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
collection_method: nil,
default_payment_method: nil,
description: nil,
invoice_settings: nil,
on_behalf_of: nil,
transfer_data: nil
)
@application_fee_percent = application_fee_percent
@automatic_tax = automatic_tax
@billing_cycle_anchor = billing_cycle_anchor
@collection_method = collection_method
@default_payment_method = default_payment_method
@description = description
@invoice_settings = invoice_settings
@on_behalf_of = on_behalf_of
@transfer_data = transfer_data
end
end
class Phase < Stripe::RequestParams
class AddInvoiceItem < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class PriceData < Stripe::RequestParams
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
attr_accessor :product
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
attr_accessor :tax_behavior
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
attr_accessor :unit_amount
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
attr_accessor :unit_amount_decimal
def initialize(
currency: nil,
product: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
)
@currency = currency
@product = product
@tax_behavior = tax_behavior
@unit_amount = unit_amount
@unit_amount_decimal = unit_amount_decimal
end
end
# The coupons to redeem into discounts for the item.
attr_accessor :discounts
# The ID of the price object. One of `price` or `price_data` is required.
attr_accessor :price
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
attr_accessor :price_data
# Quantity for this item. Defaults to 1.
attr_accessor :quantity
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
attr_accessor :tax_rates
def initialize(discounts: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil)
@discounts = discounts
@price = price
@price_data = price_data
@quantity = quantity
@tax_rates = tax_rates
end
end
class AutomaticTax < Stripe::RequestParams
class Liability < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
attr_accessor :enabled
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
attr_accessor :liability
def initialize(enabled: nil, liability: nil)
@enabled = enabled
@liability = liability
end
end
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class InvoiceSettings < Stripe::RequestParams
class Issuer < Stripe::RequestParams
# The connected account being referenced when `type` is `account`.
attr_accessor :account
# Type of the account referenced in the request.
attr_accessor :type
def initialize(account: nil, type: nil)
@account = account
@type = type
end
end
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
attr_accessor :account_tax_ids
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
attr_accessor :days_until_due
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
attr_accessor :issuer
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil)
@account_tax_ids = account_tax_ids
@days_until_due = days_until_due
@issuer = issuer
end
end
class Item < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class PriceData < Stripe::RequestParams
class Recurring < Stripe::RequestParams
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
attr_accessor :product
# The recurring components of a price such as `interval` and `interval_count`.
attr_accessor :recurring
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
attr_accessor :tax_behavior
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
attr_accessor :unit_amount
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
attr_accessor :unit_amount_decimal
def initialize(
currency: nil,
product: nil,
recurring: nil,
tax_behavior: nil,
unit_amount: nil,
unit_amount_decimal: nil
)
@currency = currency
@product = product
@recurring = recurring
@tax_behavior = tax_behavior
@unit_amount = unit_amount
@unit_amount_decimal = unit_amount_decimal
end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
attr_accessor :converts_to
# Determines the type of trial for this item.
attr_accessor :type
def initialize(converts_to: nil, type: nil)
@converts_to = converts_to
@type = type
end
end
# The coupons to redeem into discounts for the subscription item.
attr_accessor :discounts
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
attr_accessor :metadata
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
attr_accessor :plan
# The ID of the price object.
attr_accessor :price
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
attr_accessor :price_data
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
attr_accessor :quantity
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
attr_accessor :tax_rates
# Options that configure the trial on the subscription item.
attr_accessor :trial
def initialize(
discounts: nil,
metadata: nil,
plan: nil,
price: nil,
price_data: nil,
quantity: nil,
tax_rates: nil,
trial: nil
)
@discounts = discounts
@metadata = metadata
@plan = plan
@price = price
@price_data = price_data
@quantity = quantity
@tax_rates = tax_rates
@trial = trial
end
end
class PauseCollection < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
attr_accessor :behavior
def initialize(behavior: nil)
@behavior = behavior
end
end
class TransferData < Stripe::RequestParams
# 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 destination account. By default, the entire amount is transferred to the destination.
attr_accessor :amount_percent
# ID of an existing, connected Stripe account.
attr_accessor :destination
def initialize(amount_percent: nil, destination: nil)
@amount_percent = amount_percent
@destination = destination
end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
attr_accessor :prorate_up_front
def initialize(prorate_up_front: nil)
@prorate_up_front = prorate_up_front
end
end
# Defines how the subscription should behave when a trial ends.
attr_accessor :end_behavior
def initialize(end_behavior: nil)
@end_behavior = end_behavior
end
end
# 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.
attr_accessor :add_invoice_items
# 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](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
attr_accessor :application_fee_percent
# Automatic tax settings for this phase.
attr_accessor :automatic_tax
# 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](https://stripe.com/docs/billing/subscriptions/billing-cycle).
attr_accessor :billing_cycle_anchor
# 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.
attr_accessor :collection_method
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
attr_accessor :currency
# 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.
attr_accessor :default_payment_method
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
attr_accessor :default_tax_rates
# Subscription 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.
attr_accessor :description
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
attr_accessor :discounts
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
attr_accessor :end_date
# All invoices will be billed using the specified settings.
attr_accessor :invoice_settings
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
attr_accessor :items
# 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.
attr_accessor :iterations
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
attr_accessor :metadata
# The account on behalf of which to charge, for each of the associated subscription's invoices.
attr_accessor :on_behalf_of
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
attr_accessor :pause_collection
# Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/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](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
attr_accessor :proration_behavior
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
attr_accessor :start_date
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
attr_accessor :transfer_data
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
attr_accessor :trial
# Specify trial behavior when crossing phase boundaries
attr_accessor :trial_continuation
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
attr_accessor :trial_end
# Settings related to subscription trials.
attr_accessor :trial_settings
def initialize(
add_invoice_items: nil,
application_fee_percent: nil,
automatic_tax: nil,
billing_cycle_anchor: nil,
collection_method: nil,
currency: nil,
default_payment_method: nil,
default_tax_rates: nil,
description: nil,
discounts: nil,
end_date: nil,
invoice_settings: nil,
items: nil,
iterations: nil,
metadata: nil,
on_behalf_of: nil,
pause_collection: nil,
proration_behavior: nil,
start_date: nil,
transfer_data: nil,
trial: nil,
trial_continuation: nil,
trial_end: nil,
trial_settings: nil
)
@add_invoice_items = add_invoice_items
@application_fee_percent = application_fee_percent
@automatic_tax = automatic_tax
@billing_cycle_anchor = billing_cycle_anchor
@collection_method = collection_method
@currency = currency
@default_payment_method = default_payment_method
@default_tax_rates = default_tax_rates
@description = description
@discounts = discounts
@end_date = end_date
@invoice_settings = invoice_settings
@items = items
@iterations = iterations
@metadata = metadata
@on_behalf_of = on_behalf_of
@pause_collection = pause_collection
@proration_behavior = proration_behavior
@start_date = start_date
@transfer_data = transfer_data
@trial = trial
@trial_continuation = trial_continuation
@trial_end = trial_end
@trial_settings = trial_settings
end
end
class Prebilling < Stripe::RequestParams
# This is used to determine the number of billing cycles to prebill.
attr_accessor :iterations
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
attr_accessor :update_behavior
def initialize(iterations: nil, update_behavior: nil)
@iterations = iterations
@update_behavior = update_behavior
end
end
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
attr_accessor :billing_behavior
# Object representing the subscription schedule's default settings.
attr_accessor :default_settings
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
attr_accessor :end_behavior
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
attr_accessor :phases
# If specified, the invoicing for the given billing cycle iterations will be processed now.
attr_accessor :prebilling
# If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.
attr_accessor :proration_behavior
def initialize(
billing_behavior: nil,
default_settings: nil,
end_behavior: nil,
expand: nil,
metadata: nil,
phases: nil,
prebilling: nil,
proration_behavior: nil
)
@billing_behavior = billing_behavior
@default_settings = default_settings
@end_behavior = end_behavior
@expand = expand
@metadata = metadata
@phases = phases
@prebilling = prebilling
@proration_behavior = proration_behavior
end
end
class AmendParams < Stripe::RequestParams
class Amendment < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
attr_accessor :discount
def initialize(discount: nil)
@discount = discount
end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Use the `end` time of a given discount.
attr_accessor :discount_end
# Time span for the amendment starting from the `amendment_start`.
attr_accessor :duration
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
attr_accessor :timestamp
# Select one of three ways to pass the `amendment_end`.
attr_accessor :type
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil)
@discount_end = discount_end
@duration = duration
@timestamp = timestamp
@type = type
end
end
class AmendmentStart < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
attr_accessor :index
def initialize(index: nil)
@index = index
end
end
class DiscountEnd < Stripe::RequestParams
# The ID of a specific discount.
attr_accessor :discount
def initialize(discount: nil)
@discount = discount
end
end
# Details of another amendment in the same array, immediately after which this amendment should begin.
attr_accessor :amendment_end
# Use the `end` time of a given discount.
attr_accessor :discount_end
# A precise Unix timestamp for the amendment to start.
attr_accessor :timestamp
# Select one of three ways to pass the `amendment_start`.
attr_accessor :type
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil)
@amendment_end = amendment_end
@discount_end = discount_end
@timestamp = timestamp
@type = type
end
end
class DiscountAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(type: nil)
@type = type
end
end
# The coupon code to redeem.
attr_accessor :coupon
# An ID of an existing discount for a coupon that was already redeemed.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
attr_accessor :index
# The promotion code to redeem.
attr_accessor :promotion_code
def initialize(
coupon: nil,
discount: nil,
discount_end: nil,
index: nil,
promotion_code: nil
)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@index = index
@promotion_code = promotion_code
end
end
class Remove < Stripe::RequestParams
# The coupon code to remove from the `discounts` array.
attr_accessor :coupon
# The ID of a discount to remove from the `discounts` array.
attr_accessor :discount
# The ID of a promotion code to remove from the `discounts` array.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@promotion_code = promotion_code
end
end
class Set < Stripe::RequestParams
# The coupon code to replace the `discounts` array with.
attr_accessor :coupon
# An ID of an existing discount to replace the `discounts` array with.
attr_accessor :discount
# An ID of an existing promotion code to replace the `discounts` array with.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@promotion_code = promotion_code
end
end
# Details of the discount to add.
attr_accessor :add
# Details of the discount to remove.
attr_accessor :remove
# Details of the discount to replace the existing discounts with.
attr_accessor :set
# Determines the type of discount action.
attr_accessor :type
def initialize(add: nil, remove: nil, set: nil, type: nil)
@add = add
@remove = remove
@set = set
@type = type
end
end
class ItemAction < Stripe::RequestParams
class Add < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
attr_accessor :converts_to
# Determines the type of trial for this item.
attr_accessor :type
def initialize(converts_to: nil, type: nil)
@converts_to = converts_to
@type = type
end
end
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
attr_accessor :discounts
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
attr_accessor :metadata
# The ID of the price object.
attr_accessor :price
# Quantity for this item.
attr_accessor :quantity
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
attr_accessor :tax_rates
# Options that configure the trial on the subscription item.
attr_accessor :trial
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
)
@discounts = discounts
@metadata = metadata
@price = price
@quantity = quantity
@tax_rates = tax_rates
@trial = trial
end
end
class Remove < Stripe::RequestParams
# ID of a price to remove.
attr_accessor :price
def initialize(price: nil)
@price = price
end
end
class Set < Stripe::RequestParams
class Discount < Stripe::RequestParams
class DiscountEnd < Stripe::RequestParams
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# Time span for the redeemed discount.
attr_accessor :duration
# A precise Unix timestamp for the discount to end. Must be in the future.
attr_accessor :timestamp
# The type of calculation made to determine when the discount ends.
attr_accessor :type
def initialize(duration: nil, timestamp: nil, type: nil)
@duration = duration
@timestamp = timestamp
@type = type
end
end
# ID of the coupon to create a new discount for.
attr_accessor :coupon
# ID of an existing discount on the object (or one of its ancestors) to reuse.
attr_accessor :discount
# Details to determine how long the discount should be applied for.
attr_accessor :discount_end
# ID of the promotion code to create a new discount for.
attr_accessor :promotion_code
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
@coupon = coupon
@discount = discount
@discount_end = discount_end
@promotion_code = promotion_code
end
end
class Trial < Stripe::RequestParams
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
attr_accessor :converts_to
# Determines the type of trial for this item.
attr_accessor :type
def initialize(converts_to: nil, type: nil)
@converts_to = converts_to
@type = type
end
end
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
attr_accessor :discounts
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
attr_accessor :metadata
# The ID of the price object.
attr_accessor :price
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
attr_accessor :quantity
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
attr_accessor :tax_rates
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
attr_accessor :trial
def initialize(
discounts: nil,
metadata: nil,
price: nil,
quantity: nil,
tax_rates: nil,
trial: nil
)
@discounts = discounts
@metadata = metadata
@price = price
@quantity = quantity
@tax_rates = tax_rates
@trial = trial
end
end
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
attr_accessor :add
# Details of the subscription item to remove.
attr_accessor :remove
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
attr_accessor :set
# Determines the type of item action.
attr_accessor :type
def initialize(add: nil, remove: nil, set: nil, type: nil)
@add = add
@remove = remove
@set = set
@type = type
end
end
class MetadataAction < Stripe::RequestParams
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
attr_accessor :add
# Keys to remove from schedule phase metadata.
attr_accessor :remove
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
attr_accessor :set
# Select one of three ways to update phase-level `metadata` on subscription schedules.
attr_accessor :type
def initialize(add: nil, remove: nil, set: nil, type: nil)
@add = add
@remove = remove
@set = set
@type = type
end
end
class SetPauseCollection < Stripe::RequestParams
class Set < Stripe::RequestParams
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
attr_accessor :behavior
def initialize(behavior: nil)
@behavior = behavior
end
end
# Details of the pause_collection behavior to apply to the amendment.
attr_accessor :set
# Determines the type of the pause_collection amendment.
attr_accessor :type
def initialize(set: nil, type: nil)
@set = set
@type = type
end
end
class TrialSettings < Stripe::RequestParams
class EndBehavior < Stripe::RequestParams
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
attr_accessor :prorate_up_front
def initialize(prorate_up_front: nil)
@prorate_up_front = prorate_up_front
end
end
# Defines how the subscription should behave when a trial ends.
attr_accessor :end_behavior
def initialize(end_behavior: nil)
@end_behavior = end_behavior
end
end
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
attr_accessor :amendment_end
# Details to identify the earliest timestamp where the proposed change should take effect.
attr_accessor :amendment_start
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
attr_accessor :billing_cycle_anchor
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
attr_accessor :discount_actions
# Changes to the subscription items during the amendment time span.
attr_accessor :item_actions
# Instructions for how to modify phase metadata
attr_accessor :metadata_actions
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
attr_accessor :proration_behavior
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
attr_accessor :set_pause_collection
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
attr_accessor :set_schedule_end
# Settings related to subscription trials.
attr_accessor :trial_settings
def initialize(
amendment_end: nil,
amendment_start: nil,
billing_cycle_anchor: nil,
discount_actions: nil,
item_actions: nil,
metadata_actions: nil,
proration_behavior: nil,
set_pause_collection: nil,
set_schedule_end: nil,
trial_settings: nil
)
@amendment_end = amendment_end
@amendment_start = amendment_start
@billing_cycle_anchor = billing_cycle_anchor
@discount_actions = discount_actions
@item_actions = item_actions
@metadata_actions = metadata_actions
@proration_behavior = proration_behavior
@set_pause_collection = set_pause_collection
@set_schedule_end = set_schedule_end
@trial_settings = trial_settings
end
end
class Prebilling < Stripe::RequestParams
class BillFrom < Stripe::RequestParams
class AmendmentStart < Stripe::RequestParams
# The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
attr_accessor :index
def initialize(index: nil)
@index = index
end
end
# Start the prebilled period when a specified amendment begins.
attr_accessor :amendment_start
# Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
attr_accessor :timestamp
# Select one of several ways to pass the `bill_from` value.
attr_accessor :type
def initialize(amendment_start: nil, timestamp: nil, type: nil)
@amendment_start = amendment_start
@timestamp = timestamp
@type = type
end
end
class BillUntil < Stripe::RequestParams
class AmendmentEnd < Stripe::RequestParams
# The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
attr_accessor :index
def initialize(index: nil)
@index = index
end
end
class Duration < Stripe::RequestParams
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
attr_accessor :interval
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
attr_accessor :interval_count
def initialize(interval: nil, interval_count: nil)
@interval = interval
@interval_count = interval_count
end
end
# End the prebilled period when a specified amendment ends.
attr_accessor :amendment_end
# Time span for prebilling, starting from `bill_from`.
attr_accessor :duration
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
attr_accessor :timestamp
# Select one of several ways to pass the `bill_until` value.
attr_accessor :type
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil)
@amendment_end = amendment_end
@duration = duration
@timestamp = timestamp
@type = type
end
end
# The beginning of the prebilled time period. The default value is `now`.
attr_accessor :bill_from
# The end of the prebilled time period.
attr_accessor :bill_until
# When the prebilling invoice should be created. The default value is `now`.
attr_accessor :invoice_at
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
attr_accessor :update_behavior
def initialize(bill_from: nil, bill_until: nil, invoice_at: nil, update_behavior: nil)
@bill_from = bill_from
@bill_until = bill_until
@invoice_at = invoice_at
@update_behavior = update_behavior
end
end
class ScheduleSettings < Stripe::RequestParams
# Behavior of the subscription schedule and underlying subscription when it ends.
attr_accessor :end_behavior
def initialize(end_behavior: nil)
@end_behavior = end_behavior
end
end
# Changes to apply to the phases of the subscription schedule, in the order provided.
attr_accessor :amendments
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Provide any time periods to bill in advance.
attr_accessor :prebilling
# In cases where the amendment changes the currently active phase,
# specifies if and how to prorate at the time of the request.
attr_accessor :proration_behavior
# Changes to apply to the subscription schedule.
attr_accessor :schedule_settings
def initialize(
amendments: nil,
expand: nil,
prebilling: nil,
proration_behavior: nil,
schedule_settings: nil
)
@amendments = amendments
@expand = expand
@prebilling = prebilling
@proration_behavior = proration_behavior
@schedule_settings = schedule_settings
end
end
class CancelParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
attr_accessor :invoice_now
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
attr_accessor :prorate
def initialize(expand: nil, invoice_now: nil, prorate: nil)
@expand = expand
@invoice_now = invoice_now
@prorate = prorate
end
end
class ReleaseParams < Stripe::RequestParams
# Specifies which fields in the response should be expanded.
attr_accessor :expand
# Keep any cancellation on the subscription that the schedule has set
attr_accessor :preserve_cancel_date
def initialize(expand: nil, preserve_cancel_date: nil)
@expand = expand
@preserve_cancel_date = preserve_cancel_date
end
end
# ID of the Connect Application that created the schedule.
attr_reader :application
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
attr_reader :billing_behavior
# Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
attr_reader :canceled_at
# Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
attr_reader :completed_at
# Time at which the object was created. Measured in seconds since the Unix epoch.
attr_reader :created
# Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
attr_reader :current_phase
# ID of the customer who owns the subscription schedule.
attr_reader :customer
# ID of the account who owns the subscription schedule.
attr_reader :customer_account
# Attribute for field default_settings
attr_reader :default_settings
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
attr_reader :end_behavior
# Unique identifier for the object.
attr_reader :id
# Details of the most recent price migration that failed for the subscription schedule.
attr_reader :last_price_migration_error
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
attr_reader :livemode
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
attr_reader :metadata
# String representing the object's type. Objects of the same type share the same value.
attr_reader :object
# Configuration for the subscription schedule's phases.
attr_reader :phases
# Time period and invoice for a Subscription billed in advance.
attr_reader :prebilling
# Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
attr_reader :released_at
# ID of the subscription once managed by the subscription schedule (if it is released).
attr_reader :released_subscription
# The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
attr_reader :status
# ID of the subscription managed by the subscription schedule.
attr_reader :subscription
# ID of the test clock this subscription schedule belongs to.
attr_reader :test_clock
# Amends an existing subscription schedule.
def amend(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Amends an existing subscription schedule.
def self.amend(schedule, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
params: params,
opts: opts
)
end
# Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
def cancel(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
def self.cancel(schedule, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(schedule) }),
params: params,
opts: opts
)
end
# Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
def self.create(params = {}, opts = {})
request_stripe_object(
method: :post,
path: "/v1/subscription_schedules",
params: params,
opts: opts
)
end
# Retrieves the list of your subscription schedules.
def self.list(params = {}, opts = {})
request_stripe_object(
method: :get,
path: "/v1/subscription_schedules",
params: params,
opts: opts
)
end
# Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
def release(params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(self["id"]) }),
params: params,
opts: opts
)
end
# Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
def self.release(schedule, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(schedule) }),
params: params,
opts: opts
)
end
# Updates an existing subscription schedule.
def self.update(schedule, params = {}, opts = {})
request_stripe_object(
method: :post,
path: format("/v1/subscription_schedules/%<schedule>s", { schedule: CGI.escape(schedule) }),
params: params,
opts: opts
)
end
end
end
Reference in New Issue View Git Blame Copy Permalink