Class: Stripe::PaymentLinkCreateParams::SubscriptionData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/payment_link_create_params.rb

Defined Under Namespace

Classes: InvoiceSettings, TrialSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(description: nil, invoice_settings: nil, metadata: nil, trial_period_days: nil, trial_settings: nil) ⇒ SubscriptionData

Returns a new instance of SubscriptionData.



641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 641

def initialize(
  description: nil,
  invoice_settings: nil,
  metadata: nil,
  trial_period_days: nil,
  trial_settings: nil
)
  @description = description
  @invoice_settings = invoice_settings
  @metadata = metadata
  @trial_period_days = trial_period_days
  @trial_settings = trial_settings
end

Instance Attribute Details

#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 Stripe surfaces and certain local payment methods UIs.



631
632
633
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 631

def description
  @description
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



633
634
635
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 633

def invoice_settings
  @invoice_settings
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.



635
636
637
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 635

def metadata
  @metadata
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.



637
638
639
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 637

def trial_period_days
  @trial_period_days
end

#trial_settings ⇒ Object

Settings related to subscription trials.



639
640
641
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 639

def trial_settings
  @trial_settings
end