StripeAPI.Types.SubscriptionsResourcePendingUpdate

Contains the types generated from the schema SubscriptionsResourcePendingUpdate

Documentation

data SubscriptionsResourcePendingUpdate

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

Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.

Constructors

SubscriptionsResourcePendingUpdate

Fields

• subscriptionsResourcePendingUpdateBillingCycleAnchor :: Maybe Int

  billing_cycle_anchor: If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices.

• subscriptionsResourcePendingUpdateExpiresAt :: Int

  expires_at: The point after which the changes reflected by this update will be discarded and no longer applied.

• subscriptionsResourcePendingUpdateSubscriptionItems :: Maybe [SubscriptionItem]

  subscription_items: List of subscription items, each with an attached plan, that will be set if the update is applied.

• subscriptionsResourcePendingUpdateTrialEnd :: Maybe Int

  trial_end: Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.

• subscriptionsResourcePendingUpdateTrialFromPlan :: Maybe Bool

  trial_from_plan: Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed.

Instances

Eq SubscriptionsResourcePendingUpdate

Defined in StripeAPI.Types.SubscriptionsResourcePendingUpdate

Methods

(==) :: SubscriptionsResourcePendingUpdate -> SubscriptionsResourcePendingUpdate -> Bool

(/=) :: SubscriptionsResourcePendingUpdate -> SubscriptionsResourcePendingUpdate -> Bool

Show SubscriptionsResourcePendingUpdate

Defined in StripeAPI.Types.SubscriptionsResourcePendingUpdate

Methods

showsPrec :: Int -> SubscriptionsResourcePendingUpdate -> ShowS

show :: SubscriptionsResourcePendingUpdate -> String

showList :: [SubscriptionsResourcePendingUpdate] -> ShowS

ToJSON SubscriptionsResourcePendingUpdate

Defined in StripeAPI.Types.SubscriptionsResourcePendingUpdate

Methods

toJSON :: SubscriptionsResourcePendingUpdate -> Value

toEncoding :: SubscriptionsResourcePendingUpdate -> Encoding

toJSONList :: [SubscriptionsResourcePendingUpdate] -> Value

toEncodingList :: [SubscriptionsResourcePendingUpdate] -> Encoding

FromJSON SubscriptionsResourcePendingUpdate

Defined in StripeAPI.Types.SubscriptionsResourcePendingUpdate

Methods

parseJSON :: Value -> Parser SubscriptionsResourcePendingUpdate

parseJSONList :: Value -> Parser [SubscriptionsResourcePendingUpdate]

mkSubscriptionsResourcePendingUpdate

Arguments

:: Int

subscriptionsResourcePendingUpdateExpiresAt

-> SubscriptionsResourcePendingUpdate

Create a new SubscriptionsResourcePendingUpdate with all required fields.