Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.SubscriptionChange

Description

Contains the types generated from the schema SubscriptionChange

Synopsis

data SubscriptionChange = SubscriptionChange {
}
mkSubscriptionChange :: SubscriptionChange
data SubscriptionChangeRevenue_schedule_type

Documentation

data SubscriptionChange Source #

Defines the object schema located at components.schemas.SubscriptionChange in the specification.

Constructors

SubscriptionChange

Fields

subscriptionChangeActivate_at :: Maybe JsonDateTime
activate_at
subscriptionChangeActivated :: Maybe Bool
activated: Returns `true` if the subscription change is activated.
subscriptionChangeAdd_ons :: Maybe [SubscriptionAddOn]
add_ons: These add-ons will be used when the subscription renews.
subscriptionChangeBilling_info :: Maybe SubscriptionChangeBillingInfo
billing_info: Accept nested attributes for three_d_secure_action_result_token_id
subscriptionChangeBusiness_entity :: Maybe BusinessEntityMini
business_entity: Business entity details
subscriptionChangeCreated_at :: Maybe JsonDateTime
created_at
subscriptionChangeCustom_fields :: Maybe CustomFields
custom_fields: The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
subscriptionChangeDeleted_at :: Maybe JsonDateTime
deleted_at
subscriptionChangeId :: Maybe Text
id: The ID of the Subscription Change.
subscriptionChangeInvoice_collection :: Maybe InvoiceCollection
invoice_collection
subscriptionChangeObject :: Maybe Text
object
subscriptionChangePlan :: Maybe PlanMini
plan: Just the important parts.
subscriptionChangeQuantity :: Maybe Int
quantity
subscriptionChangeRamp_intervals :: Maybe [SubscriptionRampIntervalResponse]
ramp_intervals: The ramp intervals representing the pricing schedule for the subscription.
subscriptionChangeRevenue_schedule_type :: Maybe SubscriptionChangeRevenue_schedule_type
revenue_schedule_type
subscriptionChangeShipping :: Maybe SubscriptionShipping
shipping
subscriptionChangeSubscription_id :: Maybe Text
subscription_id: The ID of the subscription that is going to be changed.
Constraints:
- Maximum length of 13
subscriptionChangeTax_inclusive :: Maybe Bool
tax_inclusive: This field is deprecated. Please do not use it.
subscriptionChangeUnit_amount :: Maybe Float
unit_amount
subscriptionChangeUpdated_at :: Maybe JsonDateTime
updated_at

Instances

Instances details

FromJSON SubscriptionChange Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods parseJSON :: Value -> Parser SubscriptionChange # parseJSONList :: Value -> Parser [SubscriptionChange] #
ToJSON SubscriptionChange Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods toJSON :: SubscriptionChange -> Value # toEncoding :: SubscriptionChange -> Encoding # toJSONList :: [SubscriptionChange] -> Value # toEncodingList :: [SubscriptionChange] -> Encoding #
Show SubscriptionChange Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods showsPrec :: Int -> SubscriptionChange -> ShowS # show :: SubscriptionChange -> String # showList :: [SubscriptionChange] -> ShowS #
Eq SubscriptionChange Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods (==) :: SubscriptionChange -> SubscriptionChange -> Bool # (/=) :: SubscriptionChange -> SubscriptionChange -> Bool #

mkSubscriptionChange :: SubscriptionChange Source #

Create a new SubscriptionChange with all required fields.

data SubscriptionChangeRevenue_schedule_type Source #

Defines the enum schema located at components.schemas.SubscriptionChange.properties.revenue_schedule_type in the specification.

Constructors

SubscriptionChangeRevenue_schedule_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
SubscriptionChangeRevenue_schedule_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
SubscriptionChangeRevenue_schedule_typeEnumAt_range_end	Represents the JSON value `"at_range_end"`
SubscriptionChangeRevenue_schedule_typeEnumAt_range_start	Represents the JSON value `"at_range_start"`
SubscriptionChangeRevenue_schedule_typeEnumEvenly	Represents the JSON value `"evenly"`
SubscriptionChangeRevenue_schedule_typeEnumNever	Represents the JSON value `"never"`

Instances

Instances details

FromJSON SubscriptionChangeRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods parseJSON :: Value -> Parser SubscriptionChangeRevenue_schedule_type # parseJSONList :: Value -> Parser [SubscriptionChangeRevenue_schedule_type] #
ToJSON SubscriptionChangeRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods toJSON :: SubscriptionChangeRevenue_schedule_type -> Value # toEncoding :: SubscriptionChangeRevenue_schedule_type -> Encoding # toJSONList :: [SubscriptionChangeRevenue_schedule_type] -> Value # toEncodingList :: [SubscriptionChangeRevenue_schedule_type] -> Encoding #
Show SubscriptionChangeRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods showsPrec :: Int -> SubscriptionChangeRevenue_schedule_type -> ShowS # show :: SubscriptionChangeRevenue_schedule_type -> String # showList :: [SubscriptionChangeRevenue_schedule_type] -> ShowS #
Eq SubscriptionChangeRevenue_schedule_type Source #
Instance details Defined in RecurlyClient.Types.SubscriptionChange Methods (==) :: SubscriptionChangeRevenue_schedule_type -> SubscriptionChangeRevenue_schedule_type -> Bool # (/=) :: SubscriptionChangeRevenue_schedule_type -> SubscriptionChangeRevenue_schedule_type -> Bool #