StripeAPI.Types.Subscription

Contains the types generated from the schema Subscription

Documentation

data Subscription

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

Subscriptions allow you to charge a customer on a recurring basis.

Related guide: Creating Subscriptions.

Constructors

Subscription

Fields

• subscriptionApplicationFeePercent :: Maybe Double

  application_fee_percent: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.

• subscriptionAutomaticTax :: SubscriptionAutomaticTax

  automatic_tax:

• subscriptionBillingCycleAnchor :: Int

  billing_cycle_anchor: Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices.

• subscriptionBillingThresholds :: Maybe SubscriptionBillingThresholds'

  billing_thresholds: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

• subscriptionCancelAt :: Maybe Int

  cancel_at: A date in the future at which the subscription will automatically get canceled

• subscriptionCancelAtPeriodEnd :: Bool

  cancel_at_period_end: If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.

• subscriptionCanceledAt :: Maybe Int

  canceled_at: If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.

• subscriptionCollectionMethod :: Maybe SubscriptionCollectionMethod'

  collection_method: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.

• subscriptionCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• subscriptionCurrentPeriodEnd :: Int

  current_period_end: End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

• subscriptionCurrentPeriodStart :: Int

  current_period_start: Start of the current period that the subscription has been invoiced for.

• subscriptionCustomer :: SubscriptionCustomer'Variants

  customer: ID of the customer who owns the subscription.

• subscriptionDaysUntilDue :: Maybe Int

  days_until_due: Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.

• subscriptionDefaultPaymentMethod :: Maybe SubscriptionDefaultPaymentMethod'Variants

  default_payment_method: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

• subscriptionDefaultSource :: Maybe SubscriptionDefaultSource'Variants

  default_source: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

• subscriptionDefaultTaxRates :: Maybe [TaxRate]

  default_tax_rates: The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.

• subscriptionDiscount :: Maybe SubscriptionDiscount'

  discount: Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.

• subscriptionEndedAt :: Maybe Int

  ended_at: If the subscription has ended, the date the subscription ended.

• subscriptionId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• subscriptionItems :: SubscriptionItems'

  items: List of subscription items, each with an attached price.

• subscriptionLatestInvoice :: Maybe SubscriptionLatestInvoice'Variants

  latest_invoice: The most recent invoice this subscription has generated.

• subscriptionLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• subscriptionMetadata :: Object

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• subscriptionNextPendingInvoiceItemInvoice :: Maybe Int

  next_pending_invoice_item_invoice: Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.

• subscriptionPauseCollection :: Maybe SubscriptionPauseCollection'

  pause_collection: If specified, payment collection for this subscription will be paused.

• subscriptionPendingInvoiceItemInterval :: Maybe SubscriptionPendingInvoiceItemInterval'

  pending_invoice_item_interval: Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

• subscriptionPendingSetupIntent :: Maybe SubscriptionPendingSetupIntent'Variants

  pending_setup_intent: You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.

• subscriptionPendingUpdate :: Maybe SubscriptionPendingUpdate'

  pending_update: If specified, pending updates that will be applied to the subscription once the `latest_invoice` has been paid.

• subscriptionSchedule :: Maybe SubscriptionSchedule'Variants

  schedule: The schedule attached to the subscription

• subscriptionStartDate :: Int

  start_date: Date when the subscription was first created. The date might differ from the `created` date due to backdating.

• subscriptionStatus :: SubscriptionStatus'

  status: Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`.

  For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated.

  A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.

  If subscription `collection_method=charge_automatically` it becomes `past_due` when payment to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.

  If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

• subscriptionTransferData :: Maybe SubscriptionTransferData'

  transfer_data: The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.

• subscriptionTrialEnd :: Maybe Int

  trial_end: If the subscription has a trial, the end of that trial.

• subscriptionTrialStart :: Maybe Int

  trial_start: If the subscription has a trial, the beginning of that trial.

Instances

Eq Subscription

Defined in StripeAPI.Types.Subscription

Methods

(==) :: Subscription -> Subscription -> Bool

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

Show Subscription

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> Subscription -> ShowS

show :: Subscription -> String

showList :: [Subscription] -> ShowS

ToJSON Subscription

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: Subscription -> Value

toEncoding :: Subscription -> Encoding

toJSONList :: [Subscription] -> Value

toEncodingList :: [Subscription] -> Encoding

FromJSON Subscription

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser Subscription

parseJSONList :: Value -> Parser [Subscription]

mkSubscription

Arguments

:: SubscriptionAutomaticTax

subscriptionAutomaticTax

-> Int

subscriptionBillingCycleAnchor

-> Bool

subscriptionCancelAtPeriodEnd

-> Int

subscriptionCreated

-> Int

subscriptionCurrentPeriodEnd

-> Int

subscriptionCurrentPeriodStart

-> SubscriptionCustomer'Variants

subscriptionCustomer

-> Text

subscriptionId

-> SubscriptionItems'

subscriptionItems

-> Bool

subscriptionLivemode

-> Object

subscriptionMetadata

-> Int

subscriptionStartDate

-> SubscriptionStatus'

subscriptionStatus

-> Subscription

Create a new Subscription with all required fields.

data SubscriptionBillingThresholds'

Defines the object schema located at components.schemas.subscription.properties.billing_thresholds.anyOf in the specification.

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

Constructors

SubscriptionBillingThresholds'

Fields

• subscriptionBillingThresholds'AmountGte :: Maybe Int

  amount_gte: Monetary threshold that triggers the subscription to create an invoice

• subscriptionBillingThresholds'ResetBillingCycleAnchor :: Maybe Bool

  reset_billing_cycle_anchor: Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.

Instances

Eq SubscriptionBillingThresholds'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionBillingThresholds' -> SubscriptionBillingThresholds' -> Bool

(/=) :: SubscriptionBillingThresholds' -> SubscriptionBillingThresholds' -> Bool

Show SubscriptionBillingThresholds'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionBillingThresholds' -> ShowS

show :: SubscriptionBillingThresholds' -> String

showList :: [SubscriptionBillingThresholds'] -> ShowS

ToJSON SubscriptionBillingThresholds'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionBillingThresholds' -> Value

toEncoding :: SubscriptionBillingThresholds' -> Encoding

toJSONList :: [SubscriptionBillingThresholds'] -> Value

toEncodingList :: [SubscriptionBillingThresholds'] -> Encoding

FromJSON SubscriptionBillingThresholds'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionBillingThresholds'

parseJSONList :: Value -> Parser [SubscriptionBillingThresholds']

mkSubscriptionBillingThresholds' :: SubscriptionBillingThresholds'

Create a new SubscriptionBillingThresholds' with all required fields.

data SubscriptionCollectionMethod'

Defines the enum schema located at components.schemas.subscription.properties.collection_method in the specification.

Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.

Constructors

SubscriptionCollectionMethod'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

SubscriptionCollectionMethod'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

SubscriptionCollectionMethod'EnumChargeAutomatically

Represents the JSON value "charge_automatically"

SubscriptionCollectionMethod'EnumSendInvoice

Represents the JSON value "send_invoice"

Instances

Eq SubscriptionCollectionMethod'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionCollectionMethod' -> SubscriptionCollectionMethod' -> Bool

(/=) :: SubscriptionCollectionMethod' -> SubscriptionCollectionMethod' -> Bool

Show SubscriptionCollectionMethod'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionCollectionMethod' -> ShowS

show :: SubscriptionCollectionMethod' -> String

showList :: [SubscriptionCollectionMethod'] -> ShowS

ToJSON SubscriptionCollectionMethod'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionCollectionMethod' -> Value

toEncoding :: SubscriptionCollectionMethod' -> Encoding

toJSONList :: [SubscriptionCollectionMethod'] -> Value

toEncodingList :: [SubscriptionCollectionMethod'] -> Encoding

FromJSON SubscriptionCollectionMethod'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionCollectionMethod'

parseJSONList :: Value -> Parser [SubscriptionCollectionMethod']

data SubscriptionCustomer'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.customer.anyOf in the specification.

ID of the customer who owns the subscription.

Constructors

SubscriptionCustomer'Text Text

SubscriptionCustomer'Customer Customer

SubscriptionCustomer'DeletedCustomer DeletedCustomer

Instances

Eq SubscriptionCustomer'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionCustomer'Variants -> SubscriptionCustomer'Variants -> Bool

(/=) :: SubscriptionCustomer'Variants -> SubscriptionCustomer'Variants -> Bool

Show SubscriptionCustomer'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionCustomer'Variants -> ShowS

show :: SubscriptionCustomer'Variants -> String

showList :: [SubscriptionCustomer'Variants] -> ShowS

ToJSON SubscriptionCustomer'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionCustomer'Variants -> Value

toEncoding :: SubscriptionCustomer'Variants -> Encoding

toJSONList :: [SubscriptionCustomer'Variants] -> Value

toEncodingList :: [SubscriptionCustomer'Variants] -> Encoding

FromJSON SubscriptionCustomer'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionCustomer'Variants

parseJSONList :: Value -> Parser [SubscriptionCustomer'Variants]

data SubscriptionDefaultPaymentMethod'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.default_payment_method.anyOf in the specification.

ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

Constructors

SubscriptionDefaultPaymentMethod'Text Text

SubscriptionDefaultPaymentMethod'PaymentMethod PaymentMethod

Instances

Eq SubscriptionDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionDefaultPaymentMethod'Variants -> SubscriptionDefaultPaymentMethod'Variants -> Bool

(/=) :: SubscriptionDefaultPaymentMethod'Variants -> SubscriptionDefaultPaymentMethod'Variants -> Bool

Show SubscriptionDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionDefaultPaymentMethod'Variants -> ShowS

show :: SubscriptionDefaultPaymentMethod'Variants -> String

showList :: [SubscriptionDefaultPaymentMethod'Variants] -> ShowS

ToJSON SubscriptionDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionDefaultPaymentMethod'Variants -> Value

toEncoding :: SubscriptionDefaultPaymentMethod'Variants -> Encoding

toJSONList :: [SubscriptionDefaultPaymentMethod'Variants] -> Value

toEncodingList :: [SubscriptionDefaultPaymentMethod'Variants] -> Encoding

FromJSON SubscriptionDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionDefaultPaymentMethod'Variants

parseJSONList :: Value -> Parser [SubscriptionDefaultPaymentMethod'Variants]

data SubscriptionDefaultSource'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.default_source.anyOf in the specification.

ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

Constructors

SubscriptionDefaultSource'Text Text

SubscriptionDefaultSource'AlipayAccount AlipayAccount

SubscriptionDefaultSource'BankAccount BankAccount

SubscriptionDefaultSource'BitcoinReceiver BitcoinReceiver

SubscriptionDefaultSource'Card Card

SubscriptionDefaultSource'Source Source

Instances

Eq SubscriptionDefaultSource'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionDefaultSource'Variants -> SubscriptionDefaultSource'Variants -> Bool

(/=) :: SubscriptionDefaultSource'Variants -> SubscriptionDefaultSource'Variants -> Bool

Show SubscriptionDefaultSource'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionDefaultSource'Variants -> ShowS

show :: SubscriptionDefaultSource'Variants -> String

showList :: [SubscriptionDefaultSource'Variants] -> ShowS

ToJSON SubscriptionDefaultSource'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionDefaultSource'Variants -> Value

toEncoding :: SubscriptionDefaultSource'Variants -> Encoding

toJSONList :: [SubscriptionDefaultSource'Variants] -> Value

toEncodingList :: [SubscriptionDefaultSource'Variants] -> Encoding

FromJSON SubscriptionDefaultSource'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionDefaultSource'Variants

parseJSONList :: Value -> Parser [SubscriptionDefaultSource'Variants]

data SubscriptionDiscount'

Defines the object schema located at components.schemas.subscription.properties.discount.anyOf in the specification.

Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.

Constructors

SubscriptionDiscount'

Fields

• subscriptionDiscount'CheckoutSession :: Maybe Text

  checkout_session: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

  Constraints:

  • Maximum length of 5000
• subscriptionDiscount'Coupon :: Maybe Coupon

  coupon: A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to invoices or orders. Coupons do not work with conventional one-off charges.

• subscriptionDiscount'Customer :: Maybe SubscriptionDiscount'Customer'Variants

  customer: The ID of the customer associated with this discount.

• subscriptionDiscount'End :: Maybe Int

  end: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.

• subscriptionDiscount'Id :: Maybe Text

  id: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.

  Constraints:

  • Maximum length of 5000
• subscriptionDiscount'Invoice :: Maybe Text

  invoice: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

  Constraints:

  • Maximum length of 5000
• subscriptionDiscount'InvoiceItem :: Maybe Text

  invoice_item: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

  Constraints:

  • Maximum length of 5000
• subscriptionDiscount'Object :: Maybe SubscriptionDiscount'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• subscriptionDiscount'PromotionCode :: Maybe SubscriptionDiscount'PromotionCode'Variants

  promotion_code: The promotion code applied to create this discount.

• subscriptionDiscount'Start :: Maybe Int

  start: Date that the coupon was applied.

• subscriptionDiscount'Subscription :: Maybe Text

  subscription: The subscription that this coupon is applied to, if it is applied to a particular subscription.

  Constraints:

  • Maximum length of 5000

Instances

Eq SubscriptionDiscount'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionDiscount' -> SubscriptionDiscount' -> Bool

(/=) :: SubscriptionDiscount' -> SubscriptionDiscount' -> Bool

Show SubscriptionDiscount'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionDiscount' -> ShowS

show :: SubscriptionDiscount' -> String

showList :: [SubscriptionDiscount'] -> ShowS

ToJSON SubscriptionDiscount'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionDiscount' -> Value

toEncoding :: SubscriptionDiscount' -> Encoding

toJSONList :: [SubscriptionDiscount'] -> Value

toEncodingList :: [SubscriptionDiscount'] -> Encoding

FromJSON SubscriptionDiscount'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionDiscount'

parseJSONList :: Value -> Parser [SubscriptionDiscount']

mkSubscriptionDiscount' :: SubscriptionDiscount'

Create a new SubscriptionDiscount' with all required fields.

data SubscriptionDiscount'Customer'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.discount.anyOf.properties.customer.anyOf in the specification.

The ID of the customer associated with this discount.

Constructors

SubscriptionDiscount'Customer'Text Text

SubscriptionDiscount'Customer'Customer Customer

SubscriptionDiscount'Customer'DeletedCustomer DeletedCustomer

Instances

Eq SubscriptionDiscount'Customer'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionDiscount'Customer'Variants -> SubscriptionDiscount'Customer'Variants -> Bool

(/=) :: SubscriptionDiscount'Customer'Variants -> SubscriptionDiscount'Customer'Variants -> Bool

Show SubscriptionDiscount'Customer'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionDiscount'Customer'Variants -> ShowS

show :: SubscriptionDiscount'Customer'Variants -> String

showList :: [SubscriptionDiscount'Customer'Variants] -> ShowS

ToJSON SubscriptionDiscount'Customer'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionDiscount'Customer'Variants -> Value

toEncoding :: SubscriptionDiscount'Customer'Variants -> Encoding

toJSONList :: [SubscriptionDiscount'Customer'Variants] -> Value

toEncodingList :: [SubscriptionDiscount'Customer'Variants] -> Encoding

FromJSON SubscriptionDiscount'Customer'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionDiscount'Customer'Variants

parseJSONList :: Value -> Parser [SubscriptionDiscount'Customer'Variants]

data SubscriptionDiscount'Object'

Defines the enum schema located at components.schemas.subscription.properties.discount.anyOf.properties.object in the specification.

String representing the object's type. Objects of the same type share the same value.

Constructors

SubscriptionDiscount'Object'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

SubscriptionDiscount'Object'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

SubscriptionDiscount'Object'EnumDiscount

Represents the JSON value "discount"

Instances

Eq SubscriptionDiscount'Object'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionDiscount'Object' -> SubscriptionDiscount'Object' -> Bool

(/=) :: SubscriptionDiscount'Object' -> SubscriptionDiscount'Object' -> Bool

Show SubscriptionDiscount'Object'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionDiscount'Object' -> ShowS

show :: SubscriptionDiscount'Object' -> String

showList :: [SubscriptionDiscount'Object'] -> ShowS

ToJSON SubscriptionDiscount'Object'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionDiscount'Object' -> Value

toEncoding :: SubscriptionDiscount'Object' -> Encoding

toJSONList :: [SubscriptionDiscount'Object'] -> Value

toEncodingList :: [SubscriptionDiscount'Object'] -> Encoding

FromJSON SubscriptionDiscount'Object'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionDiscount'Object'

parseJSONList :: Value -> Parser [SubscriptionDiscount'Object']

data SubscriptionDiscount'PromotionCode'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.discount.anyOf.properties.promotion_code.anyOf in the specification.

The promotion code applied to create this discount.

Constructors

SubscriptionDiscount'PromotionCode'Text Text

SubscriptionDiscount'PromotionCode'PromotionCode PromotionCode

Instances

Eq SubscriptionDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionDiscount'PromotionCode'Variants -> SubscriptionDiscount'PromotionCode'Variants -> Bool

(/=) :: SubscriptionDiscount'PromotionCode'Variants -> SubscriptionDiscount'PromotionCode'Variants -> Bool

Show SubscriptionDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionDiscount'PromotionCode'Variants -> ShowS

show :: SubscriptionDiscount'PromotionCode'Variants -> String

showList :: [SubscriptionDiscount'PromotionCode'Variants] -> ShowS

ToJSON SubscriptionDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionDiscount'PromotionCode'Variants -> Value

toEncoding :: SubscriptionDiscount'PromotionCode'Variants -> Encoding

toJSONList :: [SubscriptionDiscount'PromotionCode'Variants] -> Value

toEncodingList :: [SubscriptionDiscount'PromotionCode'Variants] -> Encoding

FromJSON SubscriptionDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionDiscount'PromotionCode'Variants

parseJSONList :: Value -> Parser [SubscriptionDiscount'PromotionCode'Variants]

data SubscriptionItems'

Defines the object schema located at components.schemas.subscription.properties.items in the specification.

List of subscription items, each with an attached price.

Constructors

SubscriptionItems'

Fields

• subscriptionItems'Data :: [SubscriptionItem]

  data: Details about each object.

• subscriptionItems'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• subscriptionItems'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq SubscriptionItems'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionItems' -> SubscriptionItems' -> Bool

(/=) :: SubscriptionItems' -> SubscriptionItems' -> Bool

Show SubscriptionItems'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionItems' -> ShowS

show :: SubscriptionItems' -> String

showList :: [SubscriptionItems'] -> ShowS

ToJSON SubscriptionItems'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionItems' -> Value

toEncoding :: SubscriptionItems' -> Encoding

toJSONList :: [SubscriptionItems'] -> Value

toEncodingList :: [SubscriptionItems'] -> Encoding

FromJSON SubscriptionItems'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionItems'

parseJSONList :: Value -> Parser [SubscriptionItems']

mkSubscriptionItems'

Arguments

:: [SubscriptionItem]

subscriptionItems'Data

-> Bool

subscriptionItems'HasMore

-> Text

subscriptionItems'Url

-> SubscriptionItems'

Create a new SubscriptionItems' with all required fields.

data SubscriptionLatestInvoice'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.latest_invoice.anyOf in the specification.

The most recent invoice this subscription has generated.

Constructors

SubscriptionLatestInvoice'Text Text

SubscriptionLatestInvoice'Invoice Invoice

Instances

Eq SubscriptionLatestInvoice'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionLatestInvoice'Variants -> SubscriptionLatestInvoice'Variants -> Bool

(/=) :: SubscriptionLatestInvoice'Variants -> SubscriptionLatestInvoice'Variants -> Bool

Show SubscriptionLatestInvoice'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionLatestInvoice'Variants -> ShowS

show :: SubscriptionLatestInvoice'Variants -> String

showList :: [SubscriptionLatestInvoice'Variants] -> ShowS

ToJSON SubscriptionLatestInvoice'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionLatestInvoice'Variants -> Value

toEncoding :: SubscriptionLatestInvoice'Variants -> Encoding

toJSONList :: [SubscriptionLatestInvoice'Variants] -> Value

toEncodingList :: [SubscriptionLatestInvoice'Variants] -> Encoding

FromJSON SubscriptionLatestInvoice'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionLatestInvoice'Variants

parseJSONList :: Value -> Parser [SubscriptionLatestInvoice'Variants]

data SubscriptionPauseCollection'

Defines the object schema located at components.schemas.subscription.properties.pause_collection.anyOf in the specification.

If specified, payment collection for this subscription will be paused.

Constructors

SubscriptionPauseCollection'

Fields

• subscriptionPauseCollection'Behavior :: Maybe SubscriptionPauseCollection'Behavior'

  behavior: The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.

• subscriptionPauseCollection'ResumesAt :: Maybe Int

  resumes_at: The time after which the subscription will resume collecting payments.

Instances

Eq SubscriptionPauseCollection'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionPauseCollection' -> SubscriptionPauseCollection' -> Bool

(/=) :: SubscriptionPauseCollection' -> SubscriptionPauseCollection' -> Bool

Show SubscriptionPauseCollection'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionPauseCollection' -> ShowS

show :: SubscriptionPauseCollection' -> String

showList :: [SubscriptionPauseCollection'] -> ShowS

ToJSON SubscriptionPauseCollection'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionPauseCollection' -> Value

toEncoding :: SubscriptionPauseCollection' -> Encoding

toJSONList :: [SubscriptionPauseCollection'] -> Value

toEncodingList :: [SubscriptionPauseCollection'] -> Encoding

FromJSON SubscriptionPauseCollection'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionPauseCollection'

parseJSONList :: Value -> Parser [SubscriptionPauseCollection']

mkSubscriptionPauseCollection' :: SubscriptionPauseCollection'

Create a new SubscriptionPauseCollection' with all required fields.

data SubscriptionPauseCollection'Behavior'

Defines the enum schema located at components.schemas.subscription.properties.pause_collection.anyOf.properties.behavior in the specification.

The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.

Constructors

SubscriptionPauseCollection'Behavior'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

SubscriptionPauseCollection'Behavior'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

SubscriptionPauseCollection'Behavior'EnumKeepAsDraft

Represents the JSON value "keep_as_draft"

SubscriptionPauseCollection'Behavior'EnumMarkUncollectible

Represents the JSON value "mark_uncollectible"

SubscriptionPauseCollection'Behavior'EnumVoid

Represents the JSON value "void"

Instances

Eq SubscriptionPauseCollection'Behavior'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionPauseCollection'Behavior' -> SubscriptionPauseCollection'Behavior' -> Bool

(/=) :: SubscriptionPauseCollection'Behavior' -> SubscriptionPauseCollection'Behavior' -> Bool

Show SubscriptionPauseCollection'Behavior'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionPauseCollection'Behavior' -> ShowS

show :: SubscriptionPauseCollection'Behavior' -> String

showList :: [SubscriptionPauseCollection'Behavior'] -> ShowS

ToJSON SubscriptionPauseCollection'Behavior'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionPauseCollection'Behavior' -> Value

toEncoding :: SubscriptionPauseCollection'Behavior' -> Encoding

toJSONList :: [SubscriptionPauseCollection'Behavior'] -> Value

toEncodingList :: [SubscriptionPauseCollection'Behavior'] -> Encoding

FromJSON SubscriptionPauseCollection'Behavior'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionPauseCollection'Behavior'

parseJSONList :: Value -> Parser [SubscriptionPauseCollection'Behavior']

data SubscriptionPendingInvoiceItemInterval'

Defines the object schema located at components.schemas.subscription.properties.pending_invoice_item_interval.anyOf in the specification.

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

Constructors

SubscriptionPendingInvoiceItemInterval'

Fields

• subscriptionPendingInvoiceItemInterval'Interval :: Maybe SubscriptionPendingInvoiceItemInterval'Interval'

  interval: Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.

• subscriptionPendingInvoiceItemInterval'IntervalCount :: Maybe Int

  interval_count: The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

Instances

Eq SubscriptionPendingInvoiceItemInterval'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionPendingInvoiceItemInterval' -> SubscriptionPendingInvoiceItemInterval' -> Bool

(/=) :: SubscriptionPendingInvoiceItemInterval' -> SubscriptionPendingInvoiceItemInterval' -> Bool

Show SubscriptionPendingInvoiceItemInterval'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionPendingInvoiceItemInterval' -> ShowS

show :: SubscriptionPendingInvoiceItemInterval' -> String

showList :: [SubscriptionPendingInvoiceItemInterval'] -> ShowS

ToJSON SubscriptionPendingInvoiceItemInterval'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionPendingInvoiceItemInterval' -> Value

toEncoding :: SubscriptionPendingInvoiceItemInterval' -> Encoding

toJSONList :: [SubscriptionPendingInvoiceItemInterval'] -> Value

toEncodingList :: [SubscriptionPendingInvoiceItemInterval'] -> Encoding

FromJSON SubscriptionPendingInvoiceItemInterval'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionPendingInvoiceItemInterval'

parseJSONList :: Value -> Parser [SubscriptionPendingInvoiceItemInterval']

mkSubscriptionPendingInvoiceItemInterval' :: SubscriptionPendingInvoiceItemInterval'

Create a new SubscriptionPendingInvoiceItemInterval' with all required fields.

data SubscriptionPendingInvoiceItemInterval'Interval'

Defines the enum schema located at components.schemas.subscription.properties.pending_invoice_item_interval.anyOf.properties.interval in the specification.

Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.

Constructors

SubscriptionPendingInvoiceItemInterval'Interval'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

SubscriptionPendingInvoiceItemInterval'Interval'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

SubscriptionPendingInvoiceItemInterval'Interval'EnumDay

Represents the JSON value "day"

SubscriptionPendingInvoiceItemInterval'Interval'EnumMonth

Represents the JSON value "month"

SubscriptionPendingInvoiceItemInterval'Interval'EnumWeek

Represents the JSON value "week"

SubscriptionPendingInvoiceItemInterval'Interval'EnumYear

Represents the JSON value "year"

Instances

Eq SubscriptionPendingInvoiceItemInterval'Interval'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionPendingInvoiceItemInterval'Interval' -> SubscriptionPendingInvoiceItemInterval'Interval' -> Bool

(/=) :: SubscriptionPendingInvoiceItemInterval'Interval' -> SubscriptionPendingInvoiceItemInterval'Interval' -> Bool

Show SubscriptionPendingInvoiceItemInterval'Interval'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionPendingInvoiceItemInterval'Interval' -> ShowS

show :: SubscriptionPendingInvoiceItemInterval'Interval' -> String

showList :: [SubscriptionPendingInvoiceItemInterval'Interval'] -> ShowS

ToJSON SubscriptionPendingInvoiceItemInterval'Interval'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionPendingInvoiceItemInterval'Interval' -> Value

toEncoding :: SubscriptionPendingInvoiceItemInterval'Interval' -> Encoding

toJSONList :: [SubscriptionPendingInvoiceItemInterval'Interval'] -> Value

toEncodingList :: [SubscriptionPendingInvoiceItemInterval'Interval'] -> Encoding

FromJSON SubscriptionPendingInvoiceItemInterval'Interval'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionPendingInvoiceItemInterval'Interval'

parseJSONList :: Value -> Parser [SubscriptionPendingInvoiceItemInterval'Interval']

data SubscriptionPendingSetupIntent'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.pending_setup_intent.anyOf in the specification.

You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.

Constructors

SubscriptionPendingSetupIntent'Text Text

SubscriptionPendingSetupIntent'SetupIntent SetupIntent

Instances

Eq SubscriptionPendingSetupIntent'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionPendingSetupIntent'Variants -> SubscriptionPendingSetupIntent'Variants -> Bool

(/=) :: SubscriptionPendingSetupIntent'Variants -> SubscriptionPendingSetupIntent'Variants -> Bool

Show SubscriptionPendingSetupIntent'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionPendingSetupIntent'Variants -> ShowS

show :: SubscriptionPendingSetupIntent'Variants -> String

showList :: [SubscriptionPendingSetupIntent'Variants] -> ShowS

ToJSON SubscriptionPendingSetupIntent'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionPendingSetupIntent'Variants -> Value

toEncoding :: SubscriptionPendingSetupIntent'Variants -> Encoding

toJSONList :: [SubscriptionPendingSetupIntent'Variants] -> Value

toEncodingList :: [SubscriptionPendingSetupIntent'Variants] -> Encoding

FromJSON SubscriptionPendingSetupIntent'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionPendingSetupIntent'Variants

parseJSONList :: Value -> Parser [SubscriptionPendingSetupIntent'Variants]

data SubscriptionPendingUpdate'

Defines the object schema located at components.schemas.subscription.properties.pending_update.anyOf in the specification.

If specified, pending updates that will be applied to the subscription once the \`latest_invoice\` has been paid.

Constructors

SubscriptionPendingUpdate'

Fields

• subscriptionPendingUpdate'BillingCycleAnchor :: 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.

• subscriptionPendingUpdate'ExpiresAt :: Maybe Int

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

• subscriptionPendingUpdate'SubscriptionItems :: Maybe [SubscriptionItem]

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

• subscriptionPendingUpdate'TrialEnd :: 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.

• subscriptionPendingUpdate'TrialFromPlan :: 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 SubscriptionPendingUpdate'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionPendingUpdate' -> SubscriptionPendingUpdate' -> Bool

(/=) :: SubscriptionPendingUpdate' -> SubscriptionPendingUpdate' -> Bool

Show SubscriptionPendingUpdate'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionPendingUpdate' -> ShowS

show :: SubscriptionPendingUpdate' -> String

showList :: [SubscriptionPendingUpdate'] -> ShowS

ToJSON SubscriptionPendingUpdate'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionPendingUpdate' -> Value

toEncoding :: SubscriptionPendingUpdate' -> Encoding

toJSONList :: [SubscriptionPendingUpdate'] -> Value

toEncodingList :: [SubscriptionPendingUpdate'] -> Encoding

FromJSON SubscriptionPendingUpdate'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionPendingUpdate'

parseJSONList :: Value -> Parser [SubscriptionPendingUpdate']

mkSubscriptionPendingUpdate' :: SubscriptionPendingUpdate'

Create a new SubscriptionPendingUpdate' with all required fields.

data SubscriptionSchedule'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.schedule.anyOf in the specification.

The schedule attached to the subscription

Constructors

SubscriptionSchedule'Text Text

SubscriptionSchedule'SubscriptionSchedule SubscriptionSchedule

Instances

Eq SubscriptionSchedule'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionSchedule'Variants -> SubscriptionSchedule'Variants -> Bool

(/=) :: SubscriptionSchedule'Variants -> SubscriptionSchedule'Variants -> Bool

Show SubscriptionSchedule'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionSchedule'Variants -> ShowS

show :: SubscriptionSchedule'Variants -> String

showList :: [SubscriptionSchedule'Variants] -> ShowS

ToJSON SubscriptionSchedule'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionSchedule'Variants -> Value

toEncoding :: SubscriptionSchedule'Variants -> Encoding

toJSONList :: [SubscriptionSchedule'Variants] -> Value

toEncodingList :: [SubscriptionSchedule'Variants] -> Encoding

FromJSON SubscriptionSchedule'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionSchedule'Variants

parseJSONList :: Value -> Parser [SubscriptionSchedule'Variants]

data SubscriptionStatus'

Defines the enum schema located at components.schemas.subscription.properties.status in the specification.

Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`.

For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated.

A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.

If subscription `collection_method=charge_automatically` it becomes `past_due` when payment to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.

If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

Constructors

SubscriptionStatus'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

SubscriptionStatus'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

SubscriptionStatus'EnumActive

Represents the JSON value "active"

SubscriptionStatus'EnumCanceled

Represents the JSON value "canceled"

SubscriptionStatus'EnumIncomplete

Represents the JSON value "incomplete"

SubscriptionStatus'EnumIncompleteExpired

Represents the JSON value "incomplete_expired"

SubscriptionStatus'EnumPastDue

Represents the JSON value "past_due"

SubscriptionStatus'EnumTrialing

Represents the JSON value "trialing"

SubscriptionStatus'EnumUnpaid

Represents the JSON value "unpaid"

Instances

Eq SubscriptionStatus'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionStatus' -> SubscriptionStatus' -> Bool

(/=) :: SubscriptionStatus' -> SubscriptionStatus' -> Bool

Show SubscriptionStatus'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionStatus' -> ShowS

show :: SubscriptionStatus' -> String

showList :: [SubscriptionStatus'] -> ShowS

ToJSON SubscriptionStatus'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionStatus' -> Value

toEncoding :: SubscriptionStatus' -> Encoding

toJSONList :: [SubscriptionStatus'] -> Value

toEncodingList :: [SubscriptionStatus'] -> Encoding

FromJSON SubscriptionStatus'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionStatus'

parseJSONList :: Value -> Parser [SubscriptionStatus']

data SubscriptionTransferData'

Defines the object schema located at components.schemas.subscription.properties.transfer_data.anyOf in the specification.

The account (if any) the subscription\'s payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription\'s invoices.

Constructors

SubscriptionTransferData'

Fields

• subscriptionTransferData'AmountPercent :: Maybe Double

  amount_percent: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

• subscriptionTransferData'Destination :: Maybe SubscriptionTransferData'Destination'Variants

  destination: The account where funds from the payment will be transferred to upon payment success.

Instances

Eq SubscriptionTransferData'

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionTransferData' -> SubscriptionTransferData' -> Bool

(/=) :: SubscriptionTransferData' -> SubscriptionTransferData' -> Bool

Show SubscriptionTransferData'

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionTransferData' -> ShowS

show :: SubscriptionTransferData' -> String

showList :: [SubscriptionTransferData'] -> ShowS

ToJSON SubscriptionTransferData'

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionTransferData' -> Value

toEncoding :: SubscriptionTransferData' -> Encoding

toJSONList :: [SubscriptionTransferData'] -> Value

toEncodingList :: [SubscriptionTransferData'] -> Encoding

FromJSON SubscriptionTransferData'

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionTransferData'

parseJSONList :: Value -> Parser [SubscriptionTransferData']

mkSubscriptionTransferData' :: SubscriptionTransferData'

Create a new SubscriptionTransferData' with all required fields.

data SubscriptionTransferData'Destination'Variants

Defines the oneOf schema located at components.schemas.subscription.properties.transfer_data.anyOf.properties.destination.anyOf in the specification.

The account where funds from the payment will be transferred to upon payment success.

Constructors

SubscriptionTransferData'Destination'Text Text

SubscriptionTransferData'Destination'Account Account

Instances

Eq SubscriptionTransferData'Destination'Variants

Defined in StripeAPI.Types.Subscription

Methods

(==) :: SubscriptionTransferData'Destination'Variants -> SubscriptionTransferData'Destination'Variants -> Bool

(/=) :: SubscriptionTransferData'Destination'Variants -> SubscriptionTransferData'Destination'Variants -> Bool

Show SubscriptionTransferData'Destination'Variants

Defined in StripeAPI.Types.Subscription

Methods

showsPrec :: Int -> SubscriptionTransferData'Destination'Variants -> ShowS

show :: SubscriptionTransferData'Destination'Variants -> String

showList :: [SubscriptionTransferData'Destination'Variants] -> ShowS

ToJSON SubscriptionTransferData'Destination'Variants

Defined in StripeAPI.Types.Subscription

Methods

toJSON :: SubscriptionTransferData'Destination'Variants -> Value

toEncoding :: SubscriptionTransferData'Destination'Variants -> Encoding

toJSONList :: [SubscriptionTransferData'Destination'Variants] -> Value

toEncodingList :: [SubscriptionTransferData'Destination'Variants] -> Encoding

FromJSON SubscriptionTransferData'Destination'Variants

Defined in StripeAPI.Types.Subscription

Methods

parseJSON :: Value -> Parser SubscriptionTransferData'Destination'Variants

parseJSONList :: Value -> Parser [SubscriptionTransferData'Destination'Variants]