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.



651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 651

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.



641
642
643
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 641

def description
  @description
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



643
644
645
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 643

def invoice_settings
  @invoice_settings
end

#metadata ⇒ Object

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



645
646
647
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 645

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.



647
648
649
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 647

def trial_period_days
  @trial_period_days
end

#trial_settings ⇒ Object

Settings related to subscription trials.



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

def trial_settings
  @trial_settings
end