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

attr_accessor, coerce_params, coerce_value, field_encodings, new, #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.



660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 660

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.



650
651
652
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 650

def description
  @description
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



652
653
654
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 652

def invoice_settings
  @invoice_settings
end

#metadata ⇒ Object

Set of key-value pairs that will declaratively set metadata on Subscriptions generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.



654
655
656
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 654

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.



656
657
658
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 656

def trial_period_days
  @trial_period_days
end

#trial_settings ⇒ Object

Settings related to subscription trials.



658
659
660
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 658

def trial_settings
  @trial_settings
end