StripeAPI.Operations.GetCustomersCustomerSubscriptions

Contains the different functions to run the operation getCustomersCustomerSubscriptions

Documentation

getCustomersCustomerSubscriptions

Arguments

:: forall m. MonadHTTP m

=> GetCustomersCustomerSubscriptionsParameters

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

-> StripeT m (Response GetCustomersCustomerSubscriptionsResponse)

Monadic computation which returns the result of the operation

GET /v1/customers/{customer}/subscriptions

<p>You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.</p>

data GetCustomersCustomerSubscriptionsParameters

Defines the object schema located at paths./v1/customers/{customer}/subscriptions.GET.parameters in the specification.

Constructors

GetCustomersCustomerSubscriptionsParameters

Fields

• getCustomersCustomerSubscriptionsParametersPathCustomer :: Text

  pathCustomer: Represents the parameter named 'customer'

  Constraints:

  • Maximum length of 5000
• getCustomersCustomerSubscriptionsParametersQueryEndingBefore :: 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
• getCustomersCustomerSubscriptionsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

• getCustomersCustomerSubscriptionsParametersQueryStartingAfter :: 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

Eq GetCustomersCustomerSubscriptionsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

(==) :: GetCustomersCustomerSubscriptionsParameters -> GetCustomersCustomerSubscriptionsParameters -> Bool

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

Show GetCustomersCustomerSubscriptionsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> GetCustomersCustomerSubscriptionsParameters -> ShowS

show :: GetCustomersCustomerSubscriptionsParameters -> String

showList :: [GetCustomersCustomerSubscriptionsParameters] -> ShowS

ToJSON GetCustomersCustomerSubscriptionsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

toJSON :: GetCustomersCustomerSubscriptionsParameters -> Value

toEncoding :: GetCustomersCustomerSubscriptionsParameters -> Encoding

toJSONList :: [GetCustomersCustomerSubscriptionsParameters] -> Value

toEncodingList :: [GetCustomersCustomerSubscriptionsParameters] -> Encoding

FromJSON GetCustomersCustomerSubscriptionsParameters

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser GetCustomersCustomerSubscriptionsParameters

parseJSONList :: Value -> Parser [GetCustomersCustomerSubscriptionsParameters]

mkGetCustomersCustomerSubscriptionsParameters

Arguments

:: Text

getCustomersCustomerSubscriptionsParametersPathCustomer

-> GetCustomersCustomerSubscriptionsParameters

Create a new GetCustomersCustomerSubscriptionsParameters with all required fields.

data GetCustomersCustomerSubscriptionsResponse

Represents a response of the operation getCustomersCustomerSubscriptions.

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

Constructors

GetCustomersCustomerSubscriptionsResponseError String

Means either no matching case available or a parse error

GetCustomersCustomerSubscriptionsResponse200 GetCustomersCustomerSubscriptionsResponseBody200

Successful response.

GetCustomersCustomerSubscriptionsResponseDefault Error

Error response.

Instances

Eq GetCustomersCustomerSubscriptionsResponse

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

(==) :: GetCustomersCustomerSubscriptionsResponse -> GetCustomersCustomerSubscriptionsResponse -> Bool

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

Show GetCustomersCustomerSubscriptionsResponse

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> GetCustomersCustomerSubscriptionsResponse -> ShowS

show :: GetCustomersCustomerSubscriptionsResponse -> String

showList :: [GetCustomersCustomerSubscriptionsResponse] -> ShowS

data GetCustomersCustomerSubscriptionsResponseBody200

Defines the object schema located at paths./v1/customers/{customer}/subscriptions.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetCustomersCustomerSubscriptionsResponseBody200

Fields

• getCustomersCustomerSubscriptionsResponseBody200Data :: [Subscription]

  data: Details about each object.

• getCustomersCustomerSubscriptionsResponseBody200HasMore :: Bool

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

• getCustomersCustomerSubscriptionsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetCustomersCustomerSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

(==) :: GetCustomersCustomerSubscriptionsResponseBody200 -> GetCustomersCustomerSubscriptionsResponseBody200 -> Bool

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

Show GetCustomersCustomerSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

showsPrec :: Int -> GetCustomersCustomerSubscriptionsResponseBody200 -> ShowS

show :: GetCustomersCustomerSubscriptionsResponseBody200 -> String

showList :: [GetCustomersCustomerSubscriptionsResponseBody200] -> ShowS

ToJSON GetCustomersCustomerSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

toJSON :: GetCustomersCustomerSubscriptionsResponseBody200 -> Value

toEncoding :: GetCustomersCustomerSubscriptionsResponseBody200 -> Encoding

toJSONList :: [GetCustomersCustomerSubscriptionsResponseBody200] -> Value

toEncodingList :: [GetCustomersCustomerSubscriptionsResponseBody200] -> Encoding

FromJSON GetCustomersCustomerSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetCustomersCustomerSubscriptions

Methods

parseJSON :: Value -> Parser GetCustomersCustomerSubscriptionsResponseBody200

parseJSONList :: Value -> Parser [GetCustomersCustomerSubscriptionsResponseBody200]

mkGetCustomersCustomerSubscriptionsResponseBody200

Arguments

:: [Subscription]

getCustomersCustomerSubscriptionsResponseBody200Data

-> Bool

getCustomersCustomerSubscriptionsResponseBody200HasMore

-> Text

getCustomersCustomerSubscriptionsResponseBody200Url

-> GetCustomersCustomerSubscriptionsResponseBody200

Create a new GetCustomersCustomerSubscriptionsResponseBody200 with all required fields.