Class: Stripe::Checkout::Session::CreateParams::SubscriptionData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/checkout/session.rb

Defined Under Namespace

Classes: InvoiceSettings, TransferData, TrialSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(application_fee_percent: nil, billing_cycle_anchor: nil, default_tax_rates: nil, description: nil, invoice_settings: nil, metadata: nil, on_behalf_of: nil, proration_behavior: nil, transfer_data: nil, trial_end: nil, trial_period_days: nil, trial_settings: nil) ⇒ SubscriptionData

Returns a new instance of SubscriptionData.



2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/stripe/resources/checkout/session.rb', line 2955

def initialize(
  application_fee_percent: nil,
  billing_cycle_anchor: nil,
  default_tax_rates: nil,
  description: nil,
  invoice_settings: nil,
  metadata: nil,
  on_behalf_of: nil,
  proration_behavior: nil,
  transfer_data: nil,
  trial_end: nil,
  trial_period_days: nil,
  trial_settings: nil
)
  @application_fee_percent = application_fee_percent
  @billing_cycle_anchor = billing_cycle_anchor
  @default_tax_rates = default_tax_rates
  @description = description
  @invoice_settings = invoice_settings
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @proration_behavior = proration_behavior
  @transfer_data = transfer_data
  @trial_end = trial_end
  @trial_period_days = trial_period_days
  @trial_settings = trial_settings
end

Instance Attribute Details

#application_fee_percent ⇒ Object

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. To use an application fee percent, the request must be made on behalf of another account, using the ‘Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).



2924
2925
2926
 
# File 'lib/stripe/resources/checkout/session.rb', line 2924

def application_fee_percent
  @application_fee_percent
end

#billing_cycle_anchor ⇒ Object

A future timestamp to anchor the subscription’s billing cycle for new subscriptions.



2926
2927
2928
 
# File 'lib/stripe/resources/checkout/session.rb', line 2926

def billing_cycle_anchor
  @billing_cycle_anchor
end

#default_tax_rates ⇒ Object

The tax rates that will apply to any subscription item that does not have ‘tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.



2930
2931
2932
 
# File 'lib/stripe/resources/checkout/session.rb', line 2930

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in the [customer portal](stripe.com/docs/customer-management).



2934
2935
2936
 
# File 'lib/stripe/resources/checkout/session.rb', line 2934

def description
  @description
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



2936
2937
2938
 
# File 'lib/stripe/resources/checkout/session.rb', line 2936

def invoice_settings
  @invoice_settings
end

#metadata ⇒ Object

Set of [key-value pairs](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`.



2938
2939
2940
 
# File 'lib/stripe/resources/checkout/session.rb', line 2938

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge, for each of the subscription’s invoices.



2940
2941
2942
 
# File 'lib/stripe/resources/checkout/session.rb', line 2940

def on_behalf_of
  @on_behalf_of
end

#proration_behavior ⇒ Object

Determines how to handle prorations resulting from the ‘billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.



2942
2943
2944
 
# File 'lib/stripe/resources/checkout/session.rb', line 2942

def proration_behavior
  @proration_behavior
end

#transfer_data ⇒ Object

If specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.



2944
2945
2946
 
# File 'lib/stripe/resources/checkout/session.rb', line 2944

def transfer_data
  @transfer_data
end

#trial_end ⇒ Object

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.



2948
2949
2950
 
# File 'lib/stripe/resources/checkout/session.rb', line 2948

def trial_end
  @trial_end
end

#trial_period_days ⇒ Object

Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.



2951
2952
2953
 
# File 'lib/stripe/resources/checkout/session.rb', line 2951

def trial_period_days
  @trial_period_days
end

#trial_settings ⇒ Object

Settings related to subscription trials.



2953
2954
2955
 
# File 'lib/stripe/resources/checkout/session.rb', line 2953

def trial_settings
  @trial_settings
end