recurly-client-0.1.0.0: Client for Recurly subscription management
Safe HaskellSafe-Inferred
LanguageHaskell2010

RecurlyClient.Operations.List_billing_infos

Description

Contains the different functions to run the operation list_billing_infos

Synopsis

Documentation

list_billing_infos Source #

Arguments

:: forall m. MonadHTTP m 
=> List_billing_infosParameters

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

-> ClientT m (Response List_billing_infosResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/billing_infos

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

data List_billing_infosParameters Source #

Defines the object schema located at paths./accounts/{account_id}/billing_infos.GET.parameters in the specification.

Constructors

List_billing_infosParameters 

Fields

  • list_billing_infosParametersPathAccount_id :: Text

    pathAccount_id: Represents the parameter named 'account_id'

    Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.

  • list_billing_infosParametersQueryBegin_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_billing_infosParametersQueryEnd_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_billing_infosParametersQueryIds :: 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_billing_infosParametersQuerySort :: Maybe List_billing_infosParametersQuerySort

    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.

data List_billing_infosParametersQuerySort Source #

Defines the enum schema located at paths./accounts/{account_id}/billing_infos.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_billing_infosParametersQuerySortOther Value

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

List_billing_infosParametersQuerySortTyped Text

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

List_billing_infosParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_billing_infosParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

data List_billing_infosResponse Source #

Represents a response of the operation list_billing_infos.

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_billing_infosResponseError is used.

Constructors

List_billing_infosResponseError String

Means either no matching case available or a parse error

List_billing_infosResponse200 BillingInfoList

A list of the the billing information for an account's

List_billing_infosResponse400 Error

Invalid or unpermitted parameter

List_billing_infosResponse404 Error

Incorrect site or account

list_billing_infosWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_billing_infosParameters

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

-> m (Response List_billing_infosResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/billing_infos

The same as list_billing_infos but accepts an explicit configuration.

list_billing_infosRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> List_billing_infosParameters

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 /accounts/{account_id}/billing_infos

The same as list_billing_infos but returns the raw ByteString.

list_billing_infosWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m 
=> Configuration

The configuration to use in the request

-> List_billing_infosParameters

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

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/billing_infos

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