StripeAPI.Operations.GetSubscriptionItems

Contains the different functions to run the operation getSubscriptionItems

Documentation

getSubscriptionItems

Arguments

:: forall m. MonadHTTP m

=> GetSubscriptionItemsParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetSubscriptionItemsResponse)

Monadic computation which returns the result of the operation

GET /v1/subscription_items

<p>Returns a list of your subscription items for a given subscription.</p>

data GetSubscriptionItemsParameters

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

Constructors

GetSubscriptionItemsParameters

Fields

• getSubscriptionItemsParametersQueryEndingBefore :: 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.

• getSubscriptionItemsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getSubscriptionItemsParametersQueryLimit :: 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.

• getSubscriptionItemsParametersQueryStartingAfter :: 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.

• getSubscriptionItemsParametersQuerySubscription :: Text

  querySubscription: Represents the parameter named 'subscription'

  The ID of the subscription whose items will be retrieved.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetSubscriptionItemsParameters

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

(==) :: GetSubscriptionItemsParameters -> GetSubscriptionItemsParameters -> Bool

(/=) :: GetSubscriptionItemsParameters -> GetSubscriptionItemsParameters -> Bool

Show GetSubscriptionItemsParameters

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

showsPrec :: Int -> GetSubscriptionItemsParameters -> ShowS

show :: GetSubscriptionItemsParameters -> String

showList :: [GetSubscriptionItemsParameters] -> ShowS

ToJSON GetSubscriptionItemsParameters

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

toJSON :: GetSubscriptionItemsParameters -> Value

toEncoding :: GetSubscriptionItemsParameters -> Encoding

toJSONList :: [GetSubscriptionItemsParameters] -> Value

toEncodingList :: [GetSubscriptionItemsParameters] -> Encoding

FromJSON GetSubscriptionItemsParameters

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

parseJSON :: Value -> Parser GetSubscriptionItemsParameters

parseJSONList :: Value -> Parser [GetSubscriptionItemsParameters]

mkGetSubscriptionItemsParameters

Arguments

:: Text

getSubscriptionItemsParametersQuerySubscription

-> GetSubscriptionItemsParameters

Create a new GetSubscriptionItemsParameters with all required fields.

data GetSubscriptionItemsResponse

Represents a response of the operation getSubscriptionItems.

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

Constructors

GetSubscriptionItemsResponseError String

Means either no matching case available or a parse error

GetSubscriptionItemsResponse200 GetSubscriptionItemsResponseBody200

Successful response.

GetSubscriptionItemsResponseDefault Error

Error response.

Instances

Eq GetSubscriptionItemsResponse

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

(==) :: GetSubscriptionItemsResponse -> GetSubscriptionItemsResponse -> Bool

(/=) :: GetSubscriptionItemsResponse -> GetSubscriptionItemsResponse -> Bool

Show GetSubscriptionItemsResponse

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

showsPrec :: Int -> GetSubscriptionItemsResponse -> ShowS

show :: GetSubscriptionItemsResponse -> String

showList :: [GetSubscriptionItemsResponse] -> ShowS

data GetSubscriptionItemsResponseBody200

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

Constructors

GetSubscriptionItemsResponseBody200

Fields

• getSubscriptionItemsResponseBody200Data :: [SubscriptionItem]

  data

• getSubscriptionItemsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getSubscriptionItemsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/subscription_items'

Instances

Eq GetSubscriptionItemsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

(==) :: GetSubscriptionItemsResponseBody200 -> GetSubscriptionItemsResponseBody200 -> Bool

(/=) :: GetSubscriptionItemsResponseBody200 -> GetSubscriptionItemsResponseBody200 -> Bool

Show GetSubscriptionItemsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

showsPrec :: Int -> GetSubscriptionItemsResponseBody200 -> ShowS

show :: GetSubscriptionItemsResponseBody200 -> String

showList :: [GetSubscriptionItemsResponseBody200] -> ShowS

ToJSON GetSubscriptionItemsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

toJSON :: GetSubscriptionItemsResponseBody200 -> Value

toEncoding :: GetSubscriptionItemsResponseBody200 -> Encoding

toJSONList :: [GetSubscriptionItemsResponseBody200] -> Value

toEncodingList :: [GetSubscriptionItemsResponseBody200] -> Encoding

FromJSON GetSubscriptionItemsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionItems

Methods

parseJSON :: Value -> Parser GetSubscriptionItemsResponseBody200

parseJSONList :: Value -> Parser [GetSubscriptionItemsResponseBody200]

mkGetSubscriptionItemsResponseBody200

Arguments

:: [SubscriptionItem]

getSubscriptionItemsResponseBody200Data

-> Bool

getSubscriptionItemsResponseBody200HasMore

-> Text

getSubscriptionItemsResponseBody200Url

-> GetSubscriptionItemsResponseBody200

Create a new GetSubscriptionItemsResponseBody200 with all required fields.