Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postSubscriptionSchedules
Synopsis
- postSubscriptionSchedules :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostSubscriptionSchedulesRequestBody -> m (Either HttpException (Response PostSubscriptionSchedulesResponse))
- postSubscriptionSchedulesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostSubscriptionSchedulesRequestBody -> m (Either HttpException (Response ByteString))
- postSubscriptionSchedulesM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesResponse))
- postSubscriptionSchedulesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostSubscriptionSchedulesRequestBody = PostSubscriptionSchedulesRequestBody {
- postSubscriptionSchedulesRequestBodyCustomer :: Maybe String
- postSubscriptionSchedulesRequestBodyDefaultSettings :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'
- postSubscriptionSchedulesRequestBodyEndBehavior :: Maybe PostSubscriptionSchedulesRequestBodyEndBehavior'
- postSubscriptionSchedulesRequestBodyExpand :: Maybe ([] String)
- postSubscriptionSchedulesRequestBodyFromSubscription :: Maybe String
- postSubscriptionSchedulesRequestBodyMetadata :: Maybe PostSubscriptionSchedulesRequestBodyMetadata'
- postSubscriptionSchedulesRequestBodyPhases :: Maybe ([] PostSubscriptionSchedulesRequestBodyPhases')
- postSubscriptionSchedulesRequestBodyStartDate :: Maybe PostSubscriptionSchedulesRequestBodyStartDate'Variants
- data PostSubscriptionSchedulesRequestBodyDefaultSettings' = PostSubscriptionSchedulesRequestBodyDefaultSettings' {
- postSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'Variants
- postSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'
- postSubscriptionSchedulesRequestBodyDefaultSettings'DefaultPaymentMethod :: Maybe String
- postSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings :: Maybe PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings'
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf2 = PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf2 {}
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'Variants
- = PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf2 PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf2
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'
- = PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumOther Value
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumTyped String
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumStringChargeAutomatically
- | PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod'EnumStringSendInvoice
- data PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' = PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' {}
- data PostSubscriptionSchedulesRequestBodyEndBehavior'
- = PostSubscriptionSchedulesRequestBodyEndBehavior'EnumOther Value
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumTyped String
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumStringCancel
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumStringNone
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumStringRelease
- | PostSubscriptionSchedulesRequestBodyEndBehavior'EnumStringRenew
- data PostSubscriptionSchedulesRequestBodyMetadata' = PostSubscriptionSchedulesRequestBodyMetadata' {
- data PostSubscriptionSchedulesRequestBodyPhases' = PostSubscriptionSchedulesRequestBodyPhases' {
- postSubscriptionSchedulesRequestBodyPhases'ApplicationFeePercent :: Maybe Double
- postSubscriptionSchedulesRequestBodyPhases'BillingThresholds :: Maybe PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'Variants
- postSubscriptionSchedulesRequestBodyPhases'CollectionMethod :: Maybe PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'
- postSubscriptionSchedulesRequestBodyPhases'Coupon :: Maybe String
- postSubscriptionSchedulesRequestBodyPhases'DefaultPaymentMethod :: Maybe String
- postSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates :: Maybe PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'Variants
- postSubscriptionSchedulesRequestBodyPhases'EndDate :: Maybe Integer
- postSubscriptionSchedulesRequestBodyPhases'InvoiceSettings :: Maybe PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings'
- postSubscriptionSchedulesRequestBodyPhases'Iterations :: Maybe Integer
- postSubscriptionSchedulesRequestBodyPhases'Plans :: [] PostSubscriptionSchedulesRequestBodyPhases'Plans'
- postSubscriptionSchedulesRequestBodyPhases'ProrationBehavior :: Maybe PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'
- postSubscriptionSchedulesRequestBodyPhases'TaxPercent :: Maybe Double
- postSubscriptionSchedulesRequestBodyPhases'Trial :: Maybe Bool
- postSubscriptionSchedulesRequestBodyPhases'TrialEnd :: Maybe Integer
- data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf2 = PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf2 {}
- data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'Variants
- = PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1
- | PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf2 PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf2
- data PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'
- = PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumOther Value
- | PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumTyped String
- | PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumStringChargeAutomatically
- | PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod'EnumStringSendInvoice
- data PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'OneOf1
- data PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' = PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' {}
- data PostSubscriptionSchedulesRequestBodyPhases'Plans' = PostSubscriptionSchedulesRequestBodyPhases'Plans' {
- postSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds :: Maybe PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'Variants
- postSubscriptionSchedulesRequestBodyPhases'Plans'Plan :: Maybe String
- postSubscriptionSchedulesRequestBodyPhases'Plans'Quantity :: Maybe Integer
- postSubscriptionSchedulesRequestBodyPhases'Plans'TaxRates :: Maybe PostSubscriptionSchedulesRequestBodyPhases'Plans'TaxRates'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf1
- data PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf2 = PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf2 {}
- data PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'Variants
- = PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf1 PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf1
- | PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf2 PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf2
- data PostSubscriptionSchedulesRequestBodyPhases'Plans'TaxRates'OneOf1
- data PostSubscriptionSchedulesRequestBodyPhases'Plans'TaxRates'Variants
- data PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'
- = PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumOther Value
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumTyped String
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumStringAlwaysInvoice
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumStringCreateProrations
- | PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior'EnumStringNone
- data PostSubscriptionSchedulesRequestBodyStartDate'OneOf1
- data PostSubscriptionSchedulesRequestBodyStartDate'Variants
- data PostSubscriptionSchedulesResponse
Documentation
postSubscriptionSchedules Source #
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> PostSubscriptionSchedulesRequestBody | The request body to send |
-> m (Either HttpException (Response PostSubscriptionSchedulesResponse)) | Monad containing the result of the operation |
POST /v1/subscription_schedules
<p>Creates a new subscription schedule object. Each customer can have up to 25 active or scheduled subscriptions.</p>
postSubscriptionSchedulesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostSubscriptionSchedulesRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_schedules
The same as postSubscriptionSchedules
but returns the raw ByteString
postSubscriptionSchedulesM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostSubscriptionSchedulesResponse)) Source #
POST /v1/subscription_schedules
Monadic version of postSubscriptionSchedules
(use with runWithConfiguration
)
postSubscriptionSchedulesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/subscription_schedules
Monadic version of postSubscriptionSchedulesRaw
(use with runWithConfiguration
)
data PostSubscriptionSchedulesRequestBody Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBody
PostSubscriptionSchedulesRequestBody | |
|
data PostSubscriptionSchedulesRequestBodyDefaultSettings' Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyDefault_settings'
Object representing the subscription schedule's default settings.
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyDefault_settings'Billing_thresholds'OneOf1
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyDefault_settings'Billing_thresholds'OneOf2
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'BillingThresholds'Variants Source #
Define the one-of schema postSubscriptionSchedulesRequestBodyDefault_settings'Billing_thresholds'
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'CollectionMethod' Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyDefault_settings'Collection_method'
Instances
data PostSubscriptionSchedulesRequestBodyDefaultSettings'InvoiceSettings' Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyDefault_settings'Invoice_settings'
Instances
data PostSubscriptionSchedulesRequestBodyEndBehavior' Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyEnd_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 PostSubscriptionSchedulesRequestBodyMetadata' Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyMetadata'
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`.
data PostSubscriptionSchedulesRequestBodyPhases' Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyPhases'
data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyPhases'Billing_thresholds'OneOf1
Instances
data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyPhases'Billing_thresholds'OneOf2
Instances
data PostSubscriptionSchedulesRequestBodyPhases'BillingThresholds'Variants Source #
Define the one-of schema postSubscriptionSchedulesRequestBodyPhases'Billing_thresholds'
Instances
data PostSubscriptionSchedulesRequestBodyPhases'CollectionMethod' Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyPhases'Collection_method'
Instances
data PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyPhases'Default_tax_rates'OneOf1
Instances
data PostSubscriptionSchedulesRequestBodyPhases'DefaultTaxRates'Variants Source #
Define the one-of schema postSubscriptionSchedulesRequestBodyPhases'Default_tax_rates'
Instances
data PostSubscriptionSchedulesRequestBodyPhases'InvoiceSettings' Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyPhases'Invoice_settings'
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Plans' Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyPhases'Plans'
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyPhases'Plans'Billing_thresholds'OneOf1
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'OneOf2 Source #
Defines the data type for the schema postSubscriptionSchedulesRequestBodyPhases'Plans'Billing_thresholds'OneOf2
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Plans'BillingThresholds'Variants Source #
Define the one-of schema postSubscriptionSchedulesRequestBodyPhases'Plans'Billing_thresholds'
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Plans'TaxRates'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyPhases'Plans'Tax_rates'OneOf1
Instances
data PostSubscriptionSchedulesRequestBodyPhases'Plans'TaxRates'Variants Source #
Define the one-of schema postSubscriptionSchedulesRequestBodyPhases'Plans'Tax_rates'
Instances
data PostSubscriptionSchedulesRequestBodyPhases'ProrationBehavior' Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyPhases'Proration_behavior'
Instances
data PostSubscriptionSchedulesRequestBodyStartDate'OneOf1 Source #
Defines the enum schema postSubscriptionSchedulesRequestBodyStart_date'OneOf1
Instances
data PostSubscriptionSchedulesRequestBodyStartDate'Variants Source #
Define the one-of schema postSubscriptionSchedulesRequestBodyStart_date'
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. When you backdate, the `billing_cycle_anchor` of the subscription is equivalent to the `start_date`.
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. |