Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.ExternalSubscription

Description

Contains the types generated from the schema ExternalSubscription

Synopsis

data ExternalSubscription = ExternalSubscription {
}
mkExternalSubscription :: ExternalSubscription

Documentation

data ExternalSubscription Source #

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

Subscription from an external resource such as Apple App Store or Google Play Store.

Constructors

ExternalSubscription

Fields

externalSubscriptionAccount :: Maybe AccountMini
account
externalSubscriptionActivated_at :: Maybe JsonDateTime
activated_at: When the external subscription was activated in the external platform.
externalSubscriptionApp_identifier :: Maybe Text
app_identifier: Identifier of the app that generated the external subscription.
externalSubscriptionAuto_renew :: Maybe Bool
auto_renew: An indication of whether or not the external subscription will auto-renew at the expiration date.
externalSubscriptionCanceled_at :: Maybe JsonDateTime
canceled_at: When the external subscription was canceled in the external platform.
externalSubscriptionCreated_at :: Maybe JsonDateTime
created_at: When the external subscription was created in Recurly.
externalSubscriptionExpires_at :: Maybe JsonDateTime
expires_at: When the external subscription expires in the external platform.
externalSubscriptionExternal_id :: Maybe Text
external_id: The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.
externalSubscriptionExternal_payment_phases :: Maybe [ExternalPaymentPhase]
external_payment_phases: The phases of the external subscription payment lifecycle.
externalSubscriptionExternal_product_reference :: Maybe ExternalProductReferenceMini
external_product_reference: External Product Reference details
externalSubscriptionId :: Maybe Text
id: System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
externalSubscriptionImported :: Maybe Bool
imported: An indication of whether or not the external subscription was created by a historical data import.
externalSubscriptionIn_grace_period :: Maybe Bool
in_grace_period: An indication of whether or not the external subscription is in a grace period.
externalSubscriptionLast_purchased :: Maybe JsonDateTime
last_purchased: When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
externalSubscriptionObject :: Maybe Text
object
externalSubscriptionQuantity :: Maybe Int
quantity: An indication of the quantity of a subscribed item's quantity.
Constraints:
- Minimum of 0.0
externalSubscriptionState :: Maybe Text
state: External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.
externalSubscriptionTest :: Maybe Bool
test: An indication of whether or not the external subscription was purchased in a sandbox environment.
externalSubscriptionTrial_ends_at :: Maybe JsonDateTime
trial_ends_at: When the external subscription trial period ends in the external platform.
externalSubscriptionTrial_started_at :: Maybe JsonDateTime
trial_started_at: When the external subscription trial period started in the external platform.
externalSubscriptionUpdated_at :: Maybe JsonDateTime
updated_at: When the external subscription was updated in Recurly.
externalSubscriptionUuid :: Maybe Text
uuid: Universally Unique Identifier created automatically.

Instances

Instances details

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

mkExternalSubscription :: ExternalSubscription Source #

Create a new ExternalSubscription with all required fields.