stripeapi-2.0.1.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostSubscriptions

Description

Contains the different functions to run the operation postSubscriptions

Synopsis

Documentation

postSubscriptions Source #

Arguments

:: forall m. MonadHTTP m 
=> PostSubscriptionsRequestBody

The request body to send

-> ClientT m (Response PostSubscriptionsResponse)

Monadic computation which returns the result of the operation

POST /v1/subscriptions

<p>Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.</p>

data PostSubscriptionsRequestBody Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostSubscriptionsRequestBody 

Fields

data PostSubscriptionsRequestBodyAddInvoiceItems' Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items in the specification.

data PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyAddInvoiceItems'PriceData' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source #

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior in the specification.

Constructors

PostSubscriptionsRequestBodyAddInvoiceItems'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.

PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'Typed Text

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

PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Instances details
Eq PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyAddInvoiceItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.add_invoice_items.items.properties.tax_rates.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyAddInvoiceItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyAutomaticTax' Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax in the specification.

Automatic tax settings for this subscription.

data PostSubscriptionsRequestBodyBillingThresholds'OneOf1 Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_thresholds.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyBillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyBillingThresholds'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.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. Pass an empty string to remove previously-defined thresholds.

Instances

Instances details
Eq PostSubscriptionsRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyBillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyCollectionMethod' Source #

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.collection_method in the specification.

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

Constructors

PostSubscriptionsRequestBodyCollectionMethod'Other Value

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

PostSubscriptionsRequestBodyCollectionMethod'Typed Text

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

PostSubscriptionsRequestBodyCollectionMethod'EnumChargeAutomatically

Represents the JSON value "charge_automatically"

PostSubscriptionsRequestBodyCollectionMethod'EnumSendInvoice

Represents the JSON value "send_invoice"

data PostSubscriptionsRequestBodyDefaultTaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_tax_rates.anyOf in the specification.

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

Instances

Instances details
Eq PostSubscriptionsRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyItems' Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items in the specification.

data PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyItems'BillingThresholds'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyItems'BillingThresholds'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.billing_thresholds.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyItems'BillingThresholds'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyItems'PriceData' Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data in the specification.

data PostSubscriptionsRequestBodyItems'PriceData'Recurring' Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyItems'PriceData'Recurring' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' Source #

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.recurring.properties.interval in the specification.

Constructors

PostSubscriptionsRequestBodyItems'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.

PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'Typed Text

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

PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumDay

Represents the JSON value "day"

PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumMonth

Represents the JSON value "month"

PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumWeek

Represents the JSON value "week"

PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval'EnumYear

Represents the JSON value "year"

Instances

Instances details
Eq PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyItems'PriceData'Recurring'Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior' Source #

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.price_data.properties.tax_behavior in the specification.

Constructors

PostSubscriptionsRequestBodyItems'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.

PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'Typed Text

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

PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumExclusive

Represents the JSON value "exclusive"

PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumInclusive

Represents the JSON value "inclusive"

PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior'EnumUnspecified

Represents the JSON value "unspecified"

Instances

Instances details
Eq PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyItems'PriceData'TaxBehavior' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyItems'TaxRates'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.items.items.properties.tax_rates.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyItems'TaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.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`.

data PostSubscriptionsRequestBodyPaymentBehavior' Source #

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_behavior in the specification.

Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=expired_incomplete`, which is a terminal state.

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.

Constructors

PostSubscriptionsRequestBodyPaymentBehavior'Other Value

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

PostSubscriptionsRequestBodyPaymentBehavior'Typed Text

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

PostSubscriptionsRequestBodyPaymentBehavior'EnumAllowIncomplete

Represents the JSON value "allow_incomplete"

PostSubscriptionsRequestBodyPaymentBehavior'EnumDefaultIncomplete

Represents the JSON value "default_incomplete"

PostSubscriptionsRequestBodyPaymentBehavior'EnumErrorIfIncomplete

Represents the JSON value "error_if_incomplete"

PostSubscriptionsRequestBodyPaymentBehavior'EnumPendingIfIncomplete

Represents the JSON value "pending_if_incomplete"

data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.

Instances

Instances details
Eq PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source #

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf.properties.interval in the specification.

Constructors

PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Other Value

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

PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'Typed Text

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

PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumDay

Represents the JSON value "day"

PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumMonth

Represents the JSON value "month"

PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumWeek

Represents the JSON value "week"

PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval'EnumYear

Represents the JSON value "year"

Instances

Instances details
Eq PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyPendingInvoiceItemInterval'OneOf1Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.pending_invoice_item_interval.anyOf in the specification.

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

Instances

Instances details
Eq PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

Show PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

ToJSON PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

FromJSON PostSubscriptionsRequestBodyPendingInvoiceItemInterval'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostSubscriptions

data PostSubscriptionsRequestBodyProrationBehavior' Source #

Defines the enum schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.proration_behavior in the specification.

Determines how to handle prorations resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`.

Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`.

Constructors

PostSubscriptionsRequestBodyProrationBehavior'Other Value

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

PostSubscriptionsRequestBodyProrationBehavior'Typed Text

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

PostSubscriptionsRequestBodyProrationBehavior'EnumAlwaysInvoice

Represents the JSON value "always_invoice"

PostSubscriptionsRequestBodyProrationBehavior'EnumCreateProrations

Represents the JSON value "create_prorations"

PostSubscriptionsRequestBodyProrationBehavior'EnumNone

Represents the JSON value "none"

data PostSubscriptionsRequestBodyTransferData' Source #

Defines the object schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data in the specification.

If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

data PostSubscriptionsRequestBodyTrialEnd'Variants Source #

Defines the oneOf schema located at paths./v1/subscriptions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.trial_end.anyOf in the specification.

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.

data PostSubscriptionsResponse Source #

Represents a response of the operation postSubscriptions.

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), PostSubscriptionsResponseError is used.

Constructors

PostSubscriptionsResponseError String

Means either no matching case available or a parse error

PostSubscriptionsResponse200 Subscription

Successful response.

PostSubscriptionsResponseDefault Error

Error response.