Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postSubscriptionSchedules
Synopsis
- postSubscriptionSchedules :: forall m. MonadHTTP m => Maybe PostSubscriptionSchedulesRequestBody -> ClientT m (Response PostSubscriptionSchedulesResponse)
- data PostSubscriptionSchedulesRequestBody = PostSubscriptionSchedulesRequestBody {
- postSubscriptionSchedulesRequestBodyCustomer :: Maybe Text
- postSubscriptionSchedulesRequestBodyDefaultSettings :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'
- postSubscriptionSchedulesRequestBodyEndBehavior :: Maybe PostSubscriptionSchedulesRequestBodyEndBehavior'
- postSubscriptionSchedulesRequestBodyExpand :: Maybe [Text]
- postSubscriptionSchedulesRequestBodyFromSubscription :: Maybe Text
- postSubscriptionSchedulesRequestBodyMetadata :: Maybe PostSubscriptionSchedulesRequestBodyMetadata'Variants
- postSubscriptionSchedulesRequestBodyPhases :: Maybe [PostSubscriptionSchedulesRequestBodyPhases']
- postSubscriptionSchedulesRequestBodyStartDate :: Maybe PostSubscriptionSchedulesRequestBodyStartDate'Variants
- mkPostSubscriptionSchedulesRequestBody :: PostSubscriptionSchedulesRequestBody
- data PostSubscriptionSchedulesRequestBodyDefaultSettings' = PostSubscriptionSchedulesRequestBodyDefaultSettings' {
- postSubscriptionSchedulesRequestBodyDefaultSettings'ApplicationFeePercent :: Maybe Double
- postSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax'
- postSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'
- postSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'Variants
- postSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'
- postSubscriptionSchedulesRequestBodyDefaultSettings'DefaultPaymentMethod :: Maybe Text
- postSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings'
- postSubscriptionSchedulesRequestBodyDefaultSettings'TransferData :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'Variants
- mkPostSubscriptionSchedulesRequestBodyDefaultSettings' :: PostSubscriptionSchedulesRequestBodyDefaultSettings'
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax' = PostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax' {}
- mkPostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax' :: Bool -> PostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax'
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'
- = PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'Other Value
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'Typed Text
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'EnumAutomatic
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'EnumPhaseStart
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 = PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 {}
- mkPostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 :: PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'Variants
- = PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'EmptyString
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'
- = PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'Other Value
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'Typed Text
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumChargeAutomatically
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumSendInvoice
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' = PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' {}
- mkPostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' :: PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings'
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1 = PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1 {}
- mkPostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1 :: Text -> PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'Variants
- data PostSubscriptionSchedulesRequestBodyEndBehavior'
- = PostSubscriptionSchedulesRequestBodyEndBehavior'Other Value
- | PostSubscriptionSchedulesRequestBodyEndBehavior'Typed Text
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumCancel
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumNone
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumRelease
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumRenew
- data PostSubscriptionSchedulesRequestBodyMetadata'Variants
- data PostSubscriptionSchedulesRequestBodyPhases' = PostSubscriptionSchedulesRequestBodyPhases' {
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems :: Maybe [PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems']
- postSubscriptionSchedulesRequestBodyPhases'ApplicationFeePercent :: Maybe Double
- postSubscriptionSchedulesRequestBodyPhases'AutomaticTax :: Maybe PostSubscriptionSchedulesRequestBodyPhases'AutomaticTax'
- postSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor :: Maybe PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'
- postSubscriptionSchedulesRequestBodyPhases'BillingThresholds :: Maybe PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'Variants
- postSubscriptionSchedulesRequestBodyPhases'CollectionMethod :: Maybe PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'
- postSubscriptionSchedulesRequestBodyPhases'Coupon :: Maybe Text
- postSubscriptionSchedulesRequestBodyPhases'DefaultPaymentMethod :: Maybe Text
- postSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates :: Maybe PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'Variants
- postSubscriptionSchedulesRequestBodyPhases'EndDate :: Maybe Int
- postSubscriptionSchedulesRequestBodyPhases'InvoiceSettings :: Maybe PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings'
- postSubscriptionSchedulesRequestBodyPhases'Items :: [PostSubscriptionSchedulesRequestBodyPhases'Items']
- postSubscriptionSchedulesRequestBodyPhases'Iterations :: Maybe Int
- postSubscriptionSchedulesRequestBodyPhases'ProrationBehavior :: Maybe PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'
- postSubscriptionSchedulesRequestBodyPhases'TransferData :: Maybe PostSubscriptionSchedulesRequestBodyPhases'TransferData'
- postSubscriptionSchedulesRequestBodyPhases'Trial :: Maybe Bool
- postSubscriptionSchedulesRequestBodyPhases'TrialEnd :: Maybe Int
- mkPostSubscriptionSchedulesRequestBodyPhases' :: [PostSubscriptionSchedulesRequestBodyPhases'Items'] -> PostSubscriptionSchedulesRequestBodyPhases'
- data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems' = PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems' {
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'Price :: Maybe Text
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData :: Maybe PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'Quantity :: Maybe Int
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'TaxRates :: Maybe PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'TaxRates'Variants
- mkPostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems' :: PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'
- data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData' = PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData' {
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'Currency :: Text
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'Product :: Text
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior :: Maybe PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'UnitAmount :: Maybe Int
- postSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData' :: Text -> Text -> PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'
- data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'
- = PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'Other Value
- | PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'Typed Text
- | PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'EnumExclusive
- | PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'EnumInclusive
- | PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified
- data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'TaxRates'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'AutomaticTax' = PostSubscriptionSchedulesRequestBodyPhases'AutomaticTax' {}
- mkPostSubscriptionSchedulesRequestBodyPhases'AutomaticTax' :: Bool -> PostSubscriptionSchedulesRequestBodyPhases'AutomaticTax'
- data PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'
- = PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'Other Value
- | PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'Typed Text
- | PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'EnumAutomatic
- | PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'EnumPhaseStart
- data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 = PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 {}
- mkPostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 :: PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'
- = PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'Other Value
- | PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'Typed Text
- | PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumChargeAutomatically
- | PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumSendInvoice
- data PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' = PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' {}
- mkPostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' :: PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings'
- data PostSubscriptionSchedulesRequestBodyPhases'Items' = PostSubscriptionSchedulesRequestBodyPhases'Items' {
- postSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds :: Maybe PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'Variants
- postSubscriptionSchedulesRequestBodyPhases'Items'Price :: Maybe Text
- postSubscriptionSchedulesRequestBodyPhases'Items'PriceData :: Maybe PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'
- postSubscriptionSchedulesRequestBodyPhases'Items'Quantity :: Maybe Int
- postSubscriptionSchedulesRequestBodyPhases'Items'TaxRates :: Maybe PostSubscriptionSchedulesRequestBodyPhases'Items'TaxRates'Variants
- mkPostSubscriptionSchedulesRequestBodyPhases'Items' :: PostSubscriptionSchedulesRequestBodyPhases'Items'
- data PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1 = PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1 {}
- mkPostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1 :: Int -> PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData' = PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData' {
- postSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Currency :: Text
- postSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Product :: Text
- postSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring :: PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'
- postSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior :: Maybe PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'
- postSubscriptionSchedulesRequestBodyPhases'Items'PriceData'UnitAmount :: Maybe Int
- postSubscriptionSchedulesRequestBodyPhases'Items'PriceData'UnitAmountDecimal :: Maybe Text
- mkPostSubscriptionSchedulesRequestBodyPhases'Items'PriceData' :: Text -> Text -> PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring' -> PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'
- data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring' = PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring' {}
- mkPostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring' :: PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval' -> PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'
- data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'
- = PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'Other Value
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'Typed Text
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumDay
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumMonth
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumWeek
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumYear
- data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'
- = PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'Other Value
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'Typed Text
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'EnumExclusive
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'EnumInclusive
- | PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'EnumUnspecified
- data PostSubscriptionSchedulesRequestBodyPhases'Items'TaxRates'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'
- = PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'Other Value
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'Typed Text
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumAlwaysInvoice
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumCreateProrations
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumNone
- data PostSubscriptionSchedulesRequestBodyPhases'TransferData' = PostSubscriptionSchedulesRequestBodyPhases'TransferData' {}
- mkPostSubscriptionSchedulesRequestBodyPhases'TransferData' :: Text -> PostSubscriptionSchedulesRequestBodyPhases'TransferData'
- data PostSubscriptionSchedulesRequestBodyStartDate'Variants
- data PostSubscriptionSchedulesResponse
Documentation
postSubscriptionSchedules Source #
:: forall m. MonadHTTP m | |
=> Maybe PostSubscriptionSchedulesRequestBody | The request body to send |
-> ClientT m (Response PostSubscriptionSchedulesResponse) | Monadic computation which returns the result of the operation |
POST /v1/subscription_schedules
<p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p>
data PostSubscriptionSchedulesRequestBody Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostSubscriptionSchedulesRequestBody | |
|
mkPostSubscriptionSchedulesRequestBody :: PostSubscriptionSchedulesRequestBody Source #
Create a new PostSubscriptionSchedulesRequestBody
with all required fields.
data PostSubscriptionSchedulesRequestBodyDefaultSettings' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings
in the specification.
Object representing the subscription schedule's default settings.
Instances
mkPostSubscriptionSchedulesRequestBodyDefaultSettings' :: PostSubscriptionSchedulesRequestBodyDefaultSettings' Source #
Create a new PostSubscriptionSchedulesRequestBodyDefaultSettings'
with all required fields.
data PostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.automatic_tax
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax' Source #
:: Bool |
|
-> PostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax' |
Create a new PostSubscriptionSchedulesRequestBodyDefaultSettings'AutomaticTax'
with all required fields.
data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.billing_cycle_anchor
in the specification.
PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'EnumAutomatic | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingCycleAnchor'EnumPhaseStart | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.billing_thresholds.anyOf
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 :: PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 Source #
Create a new PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1
with all required fields.
data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.billing_thresholds.anyOf
in the specification.
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.collection_method
in the specification.
PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumChargeAutomatically | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.invoice_settings
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' :: PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' Source #
Create a new PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings'
with all required fields.
data PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1 Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.transfer_data.anyOf
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1 Source #
:: Text |
|
-> PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1 |
Create a new PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'OneOf1
with all required fields.
data PostSubscriptionSchedulesRequestBodyDefaultSettings'TransferData'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.transfer_data.anyOf
in the specification.
Instances
data PostSubscriptionSchedulesRequestBodyEndBehavior' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.end_behavior
in the specification.
Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
PostSubscriptionSchedulesRequestBodyEndBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyEndBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyEndBehavior'EnumCancel | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyEndBehavior'EnumNone | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyEndBehavior'EnumRelease | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyEndBehavior'EnumRenew | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf
in the specification.
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
PostSubscriptionSchedulesRequestBodyMetadata'EmptyString | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyMetadata'Object Object |
Instances
data PostSubscriptionSchedulesRequestBodyPhases' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items
in the specification.
mkPostSubscriptionSchedulesRequestBodyPhases' Source #
:: [PostSubscriptionSchedulesRequestBodyPhases'Items'] | |
-> PostSubscriptionSchedulesRequestBodyPhases' |
Create a new PostSubscriptionSchedulesRequestBodyPhases'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems' :: PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems' Source #
Create a new PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items.properties.price_data
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData' Source #
Create a new PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items.properties.tax_rates.anyOf
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'TaxRates'EmptyString | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'AddInvoiceItems'TaxRates'ListTText [Text] |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'AutomaticTax' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.automatic_tax
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'AutomaticTax' Source #
:: Bool |
|
-> PostSubscriptionSchedulesRequestBodyPhases'AutomaticTax' |
Create a new PostSubscriptionSchedulesRequestBodyPhases'AutomaticTax'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.billing_cycle_anchor
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'EnumAutomatic | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'BillingCycleAnchor'EnumPhaseStart | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.billing_thresholds.anyOf
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 :: PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 Source #
Create a new PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.billing_thresholds.anyOf
in the specification.
Instances
data PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.collection_method
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumChargeAutomatically | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.default_tax_rates.anyOf
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'EmptyString | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'ListTText [Text] |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.invoice_settings
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' :: PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' Source #
Create a new PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'Items' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'Items' :: PostSubscriptionSchedulesRequestBodyPhases'Items' Source #
Create a new PostSubscriptionSchedulesRequestBodyPhases'Items'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1 Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.billing_thresholds.anyOf
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1 Source #
:: Int |
|
-> PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1 |
Create a new PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'OneOf1
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'Items'BillingThresholds'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.billing_thresholds.anyOf
in the specification.
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'Items'PriceData' Source #
Create a new PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data.properties.recurring
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring' Source #
Create a new PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'
with all required fields.
data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data.properties.recurring.properties.interval
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumDay | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumMonth | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumWeek | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'Recurring'Interval'EnumYear | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data.properties.tax_behavior
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'EnumExclusive | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'EnumInclusive | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'Items'PriceData'TaxBehavior'EnumUnspecified | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Items'TaxRates'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.tax_rates.anyOf
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'Items'TaxRates'EmptyString | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'Items'TaxRates'ListTText [Text] |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior' Source #
Defines the enum schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.proration_behavior
in the specification.
PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumAlwaysInvoice | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumCreateProrations | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumNone | Represents the JSON value |
Instances
data PostSubscriptionSchedulesRequestBodyPhases'TransferData' Source #
Defines the object schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.transfer_data
in the specification.
Instances
mkPostSubscriptionSchedulesRequestBodyPhases'TransferData' Source #
:: Text |
|
-> PostSubscriptionSchedulesRequestBodyPhases'TransferData' |
Create a new PostSubscriptionSchedulesRequestBodyPhases'TransferData'
with all required fields.
data PostSubscriptionSchedulesRequestBodyStartDate'Variants Source #
Defines the oneOf schema located at paths./v1/subscription_schedules.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.start_date.anyOf
in the specification.
When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
PostSubscriptionSchedulesRequestBodyStartDate'Now | Represents the JSON value |
PostSubscriptionSchedulesRequestBodyStartDate'Int Int |
Instances
data PostSubscriptionSchedulesResponse Source #
Represents a response of the operation postSubscriptionSchedules
.
The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostSubscriptionSchedulesResponseError
is used.
PostSubscriptionSchedulesResponseError String | Means either no matching case available or a parse error |
PostSubscriptionSchedulesResponse200 SubscriptionSchedule | Successful response. |
PostSubscriptionSchedulesResponseDefault Error | Error response. |