Class: Recurly::Requests::SubscriptionCancel

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::SubscriptionCancel

Defined in:

lib/recurly/requests/subscription_cancel.rb

Instance Attribute Summary

• #timeframe ⇒ String

  The timeframe parameter controls when the expiration takes place.

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#timeframe ⇒ String

Returns The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.

Returns:

• (String) —

  The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.

# File 'lib/recurly/requests/subscription_cancel.rb', line 11

define_attribute :timeframe, String