subscription_purchase.rb in recurly-4.5.0

- old
+ new

@@ -53,10 +53,10 @@
       # @!attribute total_billing_cycles
       #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
       define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount
       #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
       define_attribute :unit_amount, Float