Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetBillingPortalConfigurations

Description

Contains the different functions to run the operation getBillingPortalConfigurations

Synopsis

getBillingPortalConfigurations :: forall m. MonadHTTP m => GetBillingPortalConfigurationsParameters -> ClientT m (Response GetBillingPortalConfigurationsResponse)
data GetBillingPortalConfigurationsParameters = GetBillingPortalConfigurationsParameters {
}
mkGetBillingPortalConfigurationsParameters :: GetBillingPortalConfigurationsParameters
data GetBillingPortalConfigurationsResponse
data GetBillingPortalConfigurationsResponseBody200 = GetBillingPortalConfigurationsResponseBody200 {
}
mkGetBillingPortalConfigurationsResponseBody200 :: [BillingPortal'configuration] -> Bool -> Text -> GetBillingPortalConfigurationsResponseBody200

Documentation

getBillingPortalConfigurations Source #

Arguments

:: forall m. MonadHTTP m
=> GetBillingPortalConfigurationsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetBillingPortalConfigurationsResponse)	Monadic computation which returns the result of the operation

GET /v1/billing_portal/configurations

<p>Returns a list of configurations that describe the functionality of the customer portal.</p>

data GetBillingPortalConfigurationsParameters Source #

Defines the object schema located at paths./v1/billing_portal/configurations.GET.parameters in the specification.

Constructors

GetBillingPortalConfigurationsParameters

Fields

getBillingPortalConfigurationsParametersQueryActive :: Maybe Bool
queryActive: Represents the parameter named 'active'
Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
getBillingPortalConfigurationsParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named 'ending_before'
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
Constraints:
- Maximum length of 5000
getBillingPortalConfigurationsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getBillingPortalConfigurationsParametersQueryIsDefault :: Maybe Bool
queryIs_default: Represents the parameter named 'is_default'
Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
getBillingPortalConfigurationsParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getBillingPortalConfigurationsParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named 'starting_after'
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq GetBillingPortalConfigurationsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods (==) :: GetBillingPortalConfigurationsParameters -> GetBillingPortalConfigurationsParameters -> Bool # (/=) :: GetBillingPortalConfigurationsParameters -> GetBillingPortalConfigurationsParameters -> Bool #
Show GetBillingPortalConfigurationsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods showsPrec :: Int -> GetBillingPortalConfigurationsParameters -> ShowS # show :: GetBillingPortalConfigurationsParameters -> String # showList :: [GetBillingPortalConfigurationsParameters] -> ShowS #
ToJSON GetBillingPortalConfigurationsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods toJSON :: GetBillingPortalConfigurationsParameters -> Value # toEncoding :: GetBillingPortalConfigurationsParameters -> Encoding # toJSONList :: [GetBillingPortalConfigurationsParameters] -> Value # toEncodingList :: [GetBillingPortalConfigurationsParameters] -> Encoding #
FromJSON GetBillingPortalConfigurationsParameters Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods parseJSON :: Value -> Parser GetBillingPortalConfigurationsParameters # parseJSONList :: Value -> Parser [GetBillingPortalConfigurationsParameters] #

mkGetBillingPortalConfigurationsParameters :: GetBillingPortalConfigurationsParameters Source #

Create a new GetBillingPortalConfigurationsParameters with all required fields.

data GetBillingPortalConfigurationsResponse Source #

Represents a response of the operation getBillingPortalConfigurations.

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

Constructors

GetBillingPortalConfigurationsResponseError String	Means either no matching case available or a parse error
GetBillingPortalConfigurationsResponse200 GetBillingPortalConfigurationsResponseBody200	Successful response.
GetBillingPortalConfigurationsResponseDefault Error	Error response.

Instances

Instances details

Eq GetBillingPortalConfigurationsResponse Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods (==) :: GetBillingPortalConfigurationsResponse -> GetBillingPortalConfigurationsResponse -> Bool # (/=) :: GetBillingPortalConfigurationsResponse -> GetBillingPortalConfigurationsResponse -> Bool #
Show GetBillingPortalConfigurationsResponse Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods showsPrec :: Int -> GetBillingPortalConfigurationsResponse -> ShowS # show :: GetBillingPortalConfigurationsResponse -> String # showList :: [GetBillingPortalConfigurationsResponse] -> ShowS #

data GetBillingPortalConfigurationsResponseBody200 Source #

Defines the object schema located at paths./v1/billing_portal/configurations.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetBillingPortalConfigurationsResponseBody200

Fields

getBillingPortalConfigurationsResponseBody200Data :: [BillingPortal'configuration]
data
getBillingPortalConfigurationsResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getBillingPortalConfigurationsResponseBody200Url :: Text
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000
- Must match pattern '^/v1/billing_portal/configurations'

Instances

Instances details

Eq GetBillingPortalConfigurationsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods (==) :: GetBillingPortalConfigurationsResponseBody200 -> GetBillingPortalConfigurationsResponseBody200 -> Bool # (/=) :: GetBillingPortalConfigurationsResponseBody200 -> GetBillingPortalConfigurationsResponseBody200 -> Bool #
Show GetBillingPortalConfigurationsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods showsPrec :: Int -> GetBillingPortalConfigurationsResponseBody200 -> ShowS # show :: GetBillingPortalConfigurationsResponseBody200 -> String # showList :: [GetBillingPortalConfigurationsResponseBody200] -> ShowS #
ToJSON GetBillingPortalConfigurationsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods toJSON :: GetBillingPortalConfigurationsResponseBody200 -> Value # toEncoding :: GetBillingPortalConfigurationsResponseBody200 -> Encoding # toJSONList :: [GetBillingPortalConfigurationsResponseBody200] -> Value # toEncodingList :: [GetBillingPortalConfigurationsResponseBody200] -> Encoding #
FromJSON GetBillingPortalConfigurationsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetBillingPortalConfigurations Methods parseJSON :: Value -> Parser GetBillingPortalConfigurationsResponseBody200 # parseJSONList :: Value -> Parser [GetBillingPortalConfigurationsResponseBody200] #

mkGetBillingPortalConfigurationsResponseBody200 Source #

Arguments

:: [BillingPortal'configuration]	`getBillingPortalConfigurationsResponseBody200Data`
-> Bool	`getBillingPortalConfigurationsResponseBody200HasMore`
-> Text	`getBillingPortalConfigurationsResponseBody200Url`
-> GetBillingPortalConfigurationsResponseBody200

Create a new GetBillingPortalConfigurationsResponseBody200 with all required fields.