Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postSubscriptionSchedulesSchedule
Synopsis
- postSubscriptionSchedulesSchedule :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionSchedulesScheduleRequestBody -> m (Either HttpException (Response PostSubscriptionSchedulesScheduleResponse))
- postSubscriptionSchedulesScheduleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionSchedulesScheduleRequestBody -> m (Either HttpException (Response ByteString))
- postSubscriptionSchedulesScheduleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesScheduleResponse))
- postSubscriptionSchedulesScheduleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostSubscriptionSchedulesScheduleRequestBody = PostSubscriptionSchedulesScheduleRequestBody {
- postSubscriptionSchedulesScheduleRequestBodyDefaultSettings :: Maybe PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'
- postSubscriptionSchedulesScheduleRequestBodyEndBehavior :: Maybe PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'
- postSubscriptionSchedulesScheduleRequestBodyExpand :: Maybe ([] Text)
- postSubscriptionSchedulesScheduleRequestBodyMetadata :: Maybe PostSubscriptionSchedulesScheduleRequestBodyMetadata'
- postSubscriptionSchedulesScheduleRequestBodyPhases :: Maybe ([] PostSubscriptionSchedulesScheduleRequestBodyPhases')
- postSubscriptionSchedulesScheduleRequestBodyProrate :: Maybe Bool
- postSubscriptionSchedulesScheduleRequestBodyProrationBehavior :: Maybe PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior'
- data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings' = PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings' {
- postSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds :: Maybe PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'Variants
- postSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod :: Maybe PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod'
- postSubscriptionSchedulesScheduleRequestBodyDefaultSettings'DefaultPaymentMethod :: Maybe Text
- postSubscriptionSchedulesScheduleRequestBodyDefaultSettings'InvoiceSettings :: Maybe PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'InvoiceSettings'
- data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf2 = PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf2 {}
- data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'Variants
- = PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf1 PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf1
- | PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf2 PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf2
- data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod'
- = PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod'EnumOther Value
- | PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod'EnumTyped Text
- | PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod'EnumStringChargeAutomatically
- | PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod'EnumStringSendInvoice
- data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'InvoiceSettings' = PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'InvoiceSettings' {}
- data PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'
- = PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'EnumOther Value
- | PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'EnumTyped Text
- | PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'EnumStringCancel
- | PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'EnumStringNone
- | PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'EnumStringRelease
- | PostSubscriptionSchedulesScheduleRequestBodyEndBehavior'EnumStringRenew
- data PostSubscriptionSchedulesScheduleRequestBodyMetadata' = PostSubscriptionSchedulesScheduleRequestBodyMetadata' {
- data PostSubscriptionSchedulesScheduleRequestBodyPhases' = PostSubscriptionSchedulesScheduleRequestBodyPhases' {
- postSubscriptionSchedulesScheduleRequestBodyPhases'ApplicationFeePercent :: Maybe Double
- postSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'Variants
- postSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod'
- postSubscriptionSchedulesScheduleRequestBodyPhases'Coupon :: Maybe Text
- postSubscriptionSchedulesScheduleRequestBodyPhases'DefaultPaymentMethod :: Maybe Text
- postSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'Variants
- postSubscriptionSchedulesScheduleRequestBodyPhases'EndDate :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'EndDate'Variants
- postSubscriptionSchedulesScheduleRequestBodyPhases'InvoiceSettings :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'InvoiceSettings'
- postSubscriptionSchedulesScheduleRequestBodyPhases'Iterations :: Maybe Integer
- postSubscriptionSchedulesScheduleRequestBodyPhases'Plans :: [] PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'
- postSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior'
- postSubscriptionSchedulesScheduleRequestBodyPhases'StartDate :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'StartDate'Variants
- postSubscriptionSchedulesScheduleRequestBodyPhases'TaxPercent :: Maybe Double
- postSubscriptionSchedulesScheduleRequestBodyPhases'Trial :: Maybe Bool
- postSubscriptionSchedulesScheduleRequestBodyPhases'TrialEnd :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'TrialEnd'Variants
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf2 = PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf2 {}
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'Variants
- = PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf1 PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf1
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf2 PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf2
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod'
- = PostSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod'EnumOther Value
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod'EnumTyped Text
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod'EnumStringChargeAutomatically
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod'EnumStringSendInvoice
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'Variants
- = PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'OneOf1 PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'OneOf1
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'ListText ([] Text)
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'EndDate'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'EndDate'Variants
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'InvoiceSettings' = PostSubscriptionSchedulesScheduleRequestBodyPhases'InvoiceSettings' {}
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans' = PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans' {
- postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'Variants
- postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'Plan :: Maybe Text
- postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'Quantity :: Maybe Integer
- postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'TaxRates :: Maybe PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'TaxRates'Variants
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf2 = PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf2 {}
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'Variants
- = PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf1 PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf1
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf2 PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf2
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'TaxRates'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'TaxRates'Variants
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior'
- = PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior'EnumOther Value
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior'EnumTyped Text
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior'EnumStringAlwaysInvoice
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior'EnumStringCreateProrations
- | PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior'EnumStringNone
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'StartDate'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'StartDate'Variants
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'TrialEnd'OneOf1
- data PostSubscriptionSchedulesScheduleRequestBodyPhases'TrialEnd'Variants
- data PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior'
- = PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior'EnumOther Value
- | PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior'EnumTyped Text
- | PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior'EnumStringAlwaysInvoice
- | PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior'EnumStringCreateProrations
- | PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior'EnumStringNone
- data PostSubscriptionSchedulesScheduleResponse
Documentation
postSubscriptionSchedulesSchedule Source #
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> Text | schedule | Constraints: Maximum length of 5000 |
-> Maybe PostSubscriptionSchedulesScheduleRequestBody | The request body to send |
-> m (Either HttpException (Response PostSubscriptionSchedulesScheduleResponse)) | Monad containing the result of the operation |
POST /v1/subscription_schedules/{schedule}
<p>Updates an existing subscription schedule.</p>
postSubscriptionSchedulesScheduleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostSubscriptionSchedulesScheduleRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_schedules/{schedule}
The same as postSubscriptionSchedulesSchedule
but returns the raw ByteString
postSubscriptionSchedulesScheduleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesScheduleResponse)) Source #
POST /v1/subscription_schedules/{schedule}
Monadic version of postSubscriptionSchedulesSchedule
(use with runWithConfiguration
)
postSubscriptionSchedulesScheduleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostSubscriptionSchedulesScheduleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_schedules/{schedule}
Monadic version of postSubscriptionSchedulesScheduleRaw
(use with runWithConfiguration
)
data PostSubscriptionSchedulesScheduleRequestBody Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBody
PostSubscriptionSchedulesScheduleRequestBody | |
|
Instances
data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings' Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyDefault_settings'
Object representing the subscription schedule's default settings.
Instances
data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyDefault_settings'Billing_thresholds'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyDefault_settings'Billing_thresholds'OneOf2
Instances
data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyDefault_settings'Billing_thresholds'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'CollectionMethod' Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyDefault_settings'Collection_method'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'InvoiceSettings' Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyDefault_settings'Invoice_settings'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyEndBehavior' Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyEnd_behavior'
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.
Instances
data PostSubscriptionSchedulesScheduleRequestBodyMetadata' Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyMetadata'
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`.
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases' Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyPhases'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Billing_thresholds'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyPhases'Billing_thresholds'OneOf2
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyPhases'Billing_thresholds'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'CollectionMethod' Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Collection_method'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Default_tax_rates'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'DefaultTaxRates'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyPhases'Default_tax_rates'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'EndDate'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'End_date'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'EndDate'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyPhases'End_date'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'InvoiceSettings' Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyPhases'Invoice_settings'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans' Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'Billing_thresholds'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'Billing_thresholds'OneOf2
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'BillingThresholds'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'Billing_thresholds'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'TaxRates'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'Tax_rates'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'Plans'TaxRates'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyPhases'Plans'Tax_rates'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'ProrationBehavior' Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Proration_behavior'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'StartDate'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Start_date'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'StartDate'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyPhases'Start_date'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'TrialEnd'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyPhases'Trial_end'OneOf1
Instances
data PostSubscriptionSchedulesScheduleRequestBodyPhases'TrialEnd'Variants Source #
Define the one-of schema postSubscriptionSchedulesScheduleRequestBodyPhases'Trial_end'
Instances
data PostSubscriptionSchedulesScheduleRequestBodyProrationBehavior' Source #
Defines the enum schema postSubscriptionSchedulesScheduleRequestBodyProration_behavior'
If the update changes the current phase, indicates if the changes should be prorated. Valid values are `create_prorations` or `none`, and the default value is `create_prorations`.
Instances
data PostSubscriptionSchedulesScheduleResponse Source #
Represents a response of the operation postSubscriptionSchedulesSchedule
.
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), PostSubscriptionSchedulesScheduleResponseError
is used.
PostSubscriptionSchedulesScheduleResponseError String | Means either no matching case available or a parse error |
PostSubscriptionSchedulesScheduleResponse200 SubscriptionSchedule | Successful response. |
PostSubscriptionSchedulesScheduleResponseDefault Error | Error response. |