RecurlyClient.Operations.List_subscription_invoices

Contains the different functions to run the operation list_subscription_invoices

Documentation

list_subscription_invoices

Arguments

:: forall m. MonadHTTP m

=> List_subscription_invoicesParameters

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

-> ClientT m (Response List_subscription_invoicesResponse)

Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/invoices

See the Pagination Guide to learn how to use pagination in the API and Client Libraries.

data List_subscription_invoicesParameters

Defines the object schema located at paths./subscriptions/{subscription_id}/invoices.GET.parameters in the specification.

Constructors

List_subscription_invoicesParameters

Fields

• list_subscription_invoicesParametersPathSubscription_id :: Text

  pathSubscription_id: Represents the parameter named 'subscription_id'

  Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.

• list_subscription_invoicesParametersQueryBegin_time :: Maybe JsonDateTime

  queryBegin_time: Represents the parameter named 'begin_time'

  Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_subscription_invoicesParametersQueryEnd_time :: Maybe JsonDateTime

  queryEnd_time: Represents the parameter named 'end_time'

  Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_subscription_invoicesParametersQueryIds :: Maybe [Text]

  queryIds: Represents the parameter named 'ids'

  Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.

  • *Important notes:**
  • The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
  • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
  • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
• list_subscription_invoicesParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  Limit number of records 1-200.

  Constraints:

  • Maxium of 200.0
  • Minimum of 1.0
• list_subscription_invoicesParametersQueryOrder :: Maybe List_subscription_invoicesParametersQueryOrder

  queryOrder: Represents the parameter named 'order'

  Sort order.

• list_subscription_invoicesParametersQuerySort :: Maybe List_subscription_invoicesParametersQuerySort

  querySort: Represents the parameter named 'sort'

  Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

• list_subscription_invoicesParametersQueryState :: Maybe List_subscription_invoicesParametersQueryState

  queryState: Represents the parameter named 'state'

  Invoice state.

• list_subscription_invoicesParametersQueryType :: Maybe List_subscription_invoicesParametersQueryType

  queryType: Represents the parameter named 'type'

  Filter by type when: - `type=charge`, only charge invoices will be returned. - `type=credit`, only credit invoices will be returned. - `type=non-legacy`, only charge and credit invoices will be returned. - `type=legacy`, only legacy invoices will be returned.

Instances

FromJSON List_subscription_invoicesParameters

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

parseJSON :: Value -> Parser List_subscription_invoicesParameters

parseJSONList :: Value -> Parser [List_subscription_invoicesParameters]

ToJSON List_subscription_invoicesParameters

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

toJSON :: List_subscription_invoicesParameters -> Value

toEncoding :: List_subscription_invoicesParameters -> Encoding

toJSONList :: [List_subscription_invoicesParameters] -> Value

toEncodingList :: [List_subscription_invoicesParameters] -> Encoding

Show List_subscription_invoicesParameters

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

showsPrec :: Int -> List_subscription_invoicesParameters -> ShowS

show :: List_subscription_invoicesParameters -> String

showList :: [List_subscription_invoicesParameters] -> ShowS

Eq List_subscription_invoicesParameters

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

(==) :: List_subscription_invoicesParameters -> List_subscription_invoicesParameters -> Bool

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

mkList_subscription_invoicesParameters

Arguments

:: Text

list_subscription_invoicesParametersPathSubscription_id

-> List_subscription_invoicesParameters

Create a new List_subscription_invoicesParameters with all required fields.

data List_subscription_invoicesParametersQueryOrder

Defines the enum schema located at paths./subscriptions/{subscription_id}/invoices.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

List_subscription_invoicesParametersQueryOrderOther Value

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

List_subscription_invoicesParametersQueryOrderTyped Text

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

List_subscription_invoicesParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_subscription_invoicesParametersQueryOrderEnumDesc

Represents the JSON value "desc"

Instances

FromJSON List_subscription_invoicesParametersQueryOrder

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

parseJSON :: Value -> Parser List_subscription_invoicesParametersQueryOrder

parseJSONList :: Value -> Parser [List_subscription_invoicesParametersQueryOrder]

ToJSON List_subscription_invoicesParametersQueryOrder

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

toJSON :: List_subscription_invoicesParametersQueryOrder -> Value

toEncoding :: List_subscription_invoicesParametersQueryOrder -> Encoding

toJSONList :: [List_subscription_invoicesParametersQueryOrder] -> Value

toEncodingList :: [List_subscription_invoicesParametersQueryOrder] -> Encoding

Show List_subscription_invoicesParametersQueryOrder

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

showsPrec :: Int -> List_subscription_invoicesParametersQueryOrder -> ShowS

show :: List_subscription_invoicesParametersQueryOrder -> String

showList :: [List_subscription_invoicesParametersQueryOrder] -> ShowS

Eq List_subscription_invoicesParametersQueryOrder

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

(==) :: List_subscription_invoicesParametersQueryOrder -> List_subscription_invoicesParametersQueryOrder -> Bool

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

data List_subscription_invoicesParametersQuerySort

Defines the enum schema located at paths./subscriptions/{subscription_id}/invoices.GET.parameters.properties.querySort in the specification.

Represents the parameter named 'sort'

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Constructors

List_subscription_invoicesParametersQuerySortOther Value

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

List_subscription_invoicesParametersQuerySortTyped Text

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

List_subscription_invoicesParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_subscription_invoicesParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

FromJSON List_subscription_invoicesParametersQuerySort

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

parseJSON :: Value -> Parser List_subscription_invoicesParametersQuerySort

parseJSONList :: Value -> Parser [List_subscription_invoicesParametersQuerySort]

ToJSON List_subscription_invoicesParametersQuerySort

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

toJSON :: List_subscription_invoicesParametersQuerySort -> Value

toEncoding :: List_subscription_invoicesParametersQuerySort -> Encoding

toJSONList :: [List_subscription_invoicesParametersQuerySort] -> Value

toEncodingList :: [List_subscription_invoicesParametersQuerySort] -> Encoding

Show List_subscription_invoicesParametersQuerySort

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

showsPrec :: Int -> List_subscription_invoicesParametersQuerySort -> ShowS

show :: List_subscription_invoicesParametersQuerySort -> String

showList :: [List_subscription_invoicesParametersQuerySort] -> ShowS

Eq List_subscription_invoicesParametersQuerySort

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

(==) :: List_subscription_invoicesParametersQuerySort -> List_subscription_invoicesParametersQuerySort -> Bool

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

data List_subscription_invoicesParametersQueryState

Defines the enum schema located at paths./subscriptions/{subscription_id}/invoices.GET.parameters.properties.queryState in the specification.

Represents the parameter named 'state'

Invoice state.

Constructors

List_subscription_invoicesParametersQueryStateOther Value

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

List_subscription_invoicesParametersQueryStateTyped Text

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

List_subscription_invoicesParametersQueryStateEnumPending

Represents the JSON value "pending"

List_subscription_invoicesParametersQueryStateEnumPast_due

Represents the JSON value "past_due"

List_subscription_invoicesParametersQueryStateEnumPaid

Represents the JSON value "paid"

List_subscription_invoicesParametersQueryStateEnumFailed

Represents the JSON value "failed"

Instances

FromJSON List_subscription_invoicesParametersQueryState

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

parseJSON :: Value -> Parser List_subscription_invoicesParametersQueryState

parseJSONList :: Value -> Parser [List_subscription_invoicesParametersQueryState]

ToJSON List_subscription_invoicesParametersQueryState

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

toJSON :: List_subscription_invoicesParametersQueryState -> Value

toEncoding :: List_subscription_invoicesParametersQueryState -> Encoding

toJSONList :: [List_subscription_invoicesParametersQueryState] -> Value

toEncodingList :: [List_subscription_invoicesParametersQueryState] -> Encoding

Show List_subscription_invoicesParametersQueryState

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

showsPrec :: Int -> List_subscription_invoicesParametersQueryState -> ShowS

show :: List_subscription_invoicesParametersQueryState -> String

showList :: [List_subscription_invoicesParametersQueryState] -> ShowS

Eq List_subscription_invoicesParametersQueryState

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

(==) :: List_subscription_invoicesParametersQueryState -> List_subscription_invoicesParametersQueryState -> Bool

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

data List_subscription_invoicesParametersQueryType

Defines the enum schema located at paths./subscriptions/{subscription_id}/invoices.GET.parameters.properties.queryType in the specification.

Represents the parameter named 'type'

Filter by type when: - `type=charge`, only charge invoices will be returned. - `type=credit`, only credit invoices will be returned. - `type=non-legacy`, only charge and credit invoices will be returned. - `type=legacy`, only legacy invoices will be returned.

Constructors

List_subscription_invoicesParametersQueryTypeOther Value

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

List_subscription_invoicesParametersQueryTypeTyped Text

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

List_subscription_invoicesParametersQueryTypeEnumCharge

Represents the JSON value "charge"

List_subscription_invoicesParametersQueryTypeEnumCredit

Represents the JSON value "credit"

List_subscription_invoicesParametersQueryTypeEnumLegacy

Represents the JSON value "legacy"

List_subscription_invoicesParametersQueryTypeEnumNon_legacy

Represents the JSON value "non-legacy"

Instances

FromJSON List_subscription_invoicesParametersQueryType

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

parseJSON :: Value -> Parser List_subscription_invoicesParametersQueryType

parseJSONList :: Value -> Parser [List_subscription_invoicesParametersQueryType]

ToJSON List_subscription_invoicesParametersQueryType

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

toJSON :: List_subscription_invoicesParametersQueryType -> Value

toEncoding :: List_subscription_invoicesParametersQueryType -> Encoding

toJSONList :: [List_subscription_invoicesParametersQueryType] -> Value

toEncodingList :: [List_subscription_invoicesParametersQueryType] -> Encoding

Show List_subscription_invoicesParametersQueryType

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

showsPrec :: Int -> List_subscription_invoicesParametersQueryType -> ShowS

show :: List_subscription_invoicesParametersQueryType -> String

showList :: [List_subscription_invoicesParametersQueryType] -> ShowS

Eq List_subscription_invoicesParametersQueryType

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

(==) :: List_subscription_invoicesParametersQueryType -> List_subscription_invoicesParametersQueryType -> Bool

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

data List_subscription_invoicesResponse

Represents a response of the operation list_subscription_invoices.

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

Constructors

List_subscription_invoicesResponseError String

Means either no matching case available or a parse error

List_subscription_invoicesResponse200 InvoiceList

A list of the subscription's invoices.

List_subscription_invoicesResponse400 Error

Invalid or unpermitted parameter.

List_subscription_invoicesResponse404 Error

Incorrect site or subscription ID.

List_subscription_invoicesResponseDefault Error

Unexpected error.

Instances

Show List_subscription_invoicesResponse

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

showsPrec :: Int -> List_subscription_invoicesResponse -> ShowS

show :: List_subscription_invoicesResponse -> String

showList :: [List_subscription_invoicesResponse] -> ShowS

Eq List_subscription_invoicesResponse

Defined in RecurlyClient.Operations.List_subscription_invoices

Methods

(==) :: List_subscription_invoicesResponse -> List_subscription_invoicesResponse -> Bool

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

list_subscription_invoicesWithConfiguration

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_subscription_invoicesParameters

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

-> m (Response List_subscription_invoicesResponse)

Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/invoices

The same as list_subscription_invoices but accepts an explicit configuration.

list_subscription_invoicesRaw

Arguments

:: forall m. MonadHTTP m

=> List_subscription_invoicesParameters

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

-> ClientT m (Response ByteString)

Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/invoices

The same as list_subscription_invoices but returns the raw ByteString.

list_subscription_invoicesWithConfigurationRaw

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_subscription_invoicesParameters

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

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /subscriptions/{subscription_id}/invoices

The same as list_subscription_invoices but accepts an explicit configuration and returns the raw ByteString.