Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

Contains the types generated from the schema SubscriptionSchedulesResourceDefaultSettings

8 types
4 values

Packagestripeapi-3.0.0.0
Exports12
LanguageHaskell2010
LicenceMIT
SourceSubscriptionSchedulesResourceDefaultSettings.hs

datadata SubscriptionSchedulesResourceDefaultSettings

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

Constructors

SubscriptionSchedulesResourceDefaultSettings
- subscriptionSchedulesResourceDefaultSettingsApplicationFeePercent :: Maybe (Nullable 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 during this phase of the schedule.
- subscriptionSchedulesResourceDefaultSettingsAutomaticTax :: Maybe SubscriptionSchedulesResourceDefaultSettingsAutomaticTax
  automatic_tax:
- subscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor :: SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'
  billing_cycle_anchor: Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
- subscriptionSchedulesResourceDefaultSettingsBillingThresholds :: Maybe (Nullable SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullable)
  billing_thresholds: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
- subscriptionSchedulesResourceDefaultSettingsCollectionMethod :: Maybe (Nullable SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullable)
  collection_method: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.
- subscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod :: Maybe (Nullable SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullableVariants)
  default_payment_method: ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
- subscriptionSchedulesResourceDefaultSettingsInvoiceSettings :: Maybe (Nullable SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullable)
  invoice_settings: The subscription schedule's default invoice settings.
- subscriptionSchedulesResourceDefaultSettingsTransferData :: Maybe (Nullable SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullable)
  transfer_data: The account (if any) the associated 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.

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

valuemkSubscriptionSchedulesResourceDefaultSettings

:: SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'
subscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor
-> SubscriptionSchedulesResourceDefaultSettings

Create a new SubscriptionSchedulesResourceDefaultSettings with all required fields.

datadata SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'

Defines the enum schema located at components.schemas.subscription_schedules_resource_default_settings.properties.billing_cycle_anchor in the specification.

Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.

Constructors

SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'EnumAutomatic
Represents the JSON value "automatic"
SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'EnumPhaseStart
Represents the JSON value "phase_start"

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

datadata SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullable

Defines the object schema located at components.schemas.subscription_schedules_resource_default_settings.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

SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullable
- subscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullableAmountGte :: Maybe (Nullable Int)
  amount_gte: Monetary threshold that triggers the subscription to create an invoice
- subscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullableResetBillingCycleAnchor :: Maybe (Nullable 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`.

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

value

mkSubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullable :: SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullable

Create a new SubscriptionSchedulesResourceDefaultSettingsBillingThresholds'NonNullable with all required fields.

datadata SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullable

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

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

Constructors

SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableEnumChargeAutomatically
Represents the JSON value "charge_automatically"
SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableEnumSendInvoice
Represents the JSON value "send_invoice"

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsCollectionMethod'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

datadata SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullableVariants

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

ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

Constructors

SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullableText Text
SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullablePaymentMethod PaymentMethod

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsDefaultPaymentMethod'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

datadata SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullable

Defines the object schema located at components.schemas.subscription_schedules_resource_default_settings.properties.invoice_settings.anyOf in the specification.

The subscription schedule\'s default invoice settings.

Constructors

SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullable
- subscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullableDaysUntilDue :: Maybe (Nullable Int)
  days_until_due: Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

value

mkSubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullable :: SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullable

Create a new SubscriptionSchedulesResourceDefaultSettingsInvoiceSettings'NonNullable with all required fields.

datadata SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullable

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

The account (if any) the associated 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

SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullable
- subscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableAmountPercent :: Maybe (Nullable 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.
- subscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination :: Maybe SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'Variants
  destination: The account where funds from the payment will be transferred to upon payment success.

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings

value

mkSubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullable :: SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullable

Create a new SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullable with all required fields.

datadata SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'Variants

Defines the oneOf schema located at components.schemas.subscription_schedules_resource_default_settings.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

SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'Text Text
SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'Account Account

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
Show SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
FromJSON SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings
ToJSON SubscriptionSchedulesResourceDefaultSettingsTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedulesResourceDefaultSettings