Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetInvoices

Contains the different functions to run the operation getInvoices

9 types
5 values

Packagestripeapi-3.0.0.0
Exports14
LanguageHaskell2010
LicenceMIT
SourceGetInvoices.hs

valuegetInvoices

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

GET /v1/invoices

<p>You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.</p>

datadata GetInvoicesParameters

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

Constructors

GetInvoicesParameters
- getInvoicesParametersQueryCollectionMethod :: Maybe GetInvoicesParametersQueryCollectionMethod'
  queryCollection_method: Represents the parameter named 'collection_method'
  The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
- getInvoicesParametersQueryCreated :: Maybe GetInvoicesParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
- getInvoicesParametersQueryCustomer :: Maybe Text
  queryCustomer: Represents the parameter named 'customer'
  Only return invoices for the customer specified by this customer ID.
  Constraints:
  - Maximum length of 5000
- getInvoicesParametersQueryDueDate :: Maybe GetInvoicesParametersQueryDueDate'Variants
  queryDue_date: Represents the parameter named 'due_date'
- getInvoicesParametersQueryEndingBefore :: 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
- getInvoicesParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getInvoicesParametersQueryLimit :: 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.
- getInvoicesParametersQueryStartingAfter :: 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
- getInvoicesParametersQueryStatus :: Maybe GetInvoicesParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more
  Constraints:
  - Maximum length of 5000
- getInvoicesParametersQuerySubscription :: Maybe Text
  querySubscription: Represents the parameter named 'subscription'
  Only return invoices for the subscription specified by this subscription ID.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

valuemkGetInvoicesParameters :: GetInvoicesParameters

Create a new GetInvoicesParameters with all required fields.

datadata GetInvoicesParametersQueryCollectionMethod'

Defines the enum schema located at paths./v1/invoices.GET.parameters.properties.queryCollection_method in the specification.

Represents the parameter named 'collection_method'

The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.

Constructors

GetInvoicesParametersQueryCollectionMethod'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetInvoicesParametersQueryCollectionMethod'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetInvoicesParametersQueryCollectionMethod'EnumChargeAutomatically
Represents the JSON value "charge_automatically"
GetInvoicesParametersQueryCollectionMethod'EnumSendInvoice
Represents the JSON value "send_invoice"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

datadata GetInvoicesParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/invoices.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetInvoicesParametersQueryCreated'OneOf1
- getInvoicesParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getInvoicesParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getInvoicesParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getInvoicesParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

valuemkGetInvoicesParametersQueryCreated'OneOf1 :: GetInvoicesParametersQueryCreated'OneOf1

Create a new GetInvoicesParametersQueryCreated'OneOf1 with all required fields.

datadata GetInvoicesParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/invoices.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetInvoicesParametersQueryCreated'GetInvoicesParametersQueryCreated'OneOf1 GetInvoicesParametersQueryCreated'OneOf1
GetInvoicesParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

datadata GetInvoicesParametersQueryDueDate'OneOf1

Defines the object schema located at paths./v1/invoices.GET.parameters.properties.queryDue_date.anyOf in the specification.

Constructors

GetInvoicesParametersQueryDueDate'OneOf1
- getInvoicesParametersQueryDueDate'OneOf1Gt :: Maybe Int
  gt
- getInvoicesParametersQueryDueDate'OneOf1Gte :: Maybe Int
  gte
- getInvoicesParametersQueryDueDate'OneOf1Lt :: Maybe Int
  lt
- getInvoicesParametersQueryDueDate'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesParametersQueryDueDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesParametersQueryDueDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesParametersQueryDueDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesParametersQueryDueDate'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

valuemkGetInvoicesParametersQueryDueDate'OneOf1 :: GetInvoicesParametersQueryDueDate'OneOf1

Create a new GetInvoicesParametersQueryDueDate'OneOf1 with all required fields.

datadata GetInvoicesParametersQueryDueDate'Variants

Defines the oneOf schema located at paths./v1/invoices.GET.parameters.properties.queryDue_date.anyOf in the specification.

Represents the parameter named 'due_date'

Constructors

GetInvoicesParametersQueryDueDate'GetInvoicesParametersQueryDueDate'OneOf1 GetInvoicesParametersQueryDueDate'OneOf1
GetInvoicesParametersQueryDueDate'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesParametersQueryDueDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesParametersQueryDueDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesParametersQueryDueDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesParametersQueryDueDate'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

datadata GetInvoicesParametersQueryStatus'

Defines the enum schema located at paths./v1/invoices.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more

Constructors

GetInvoicesParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetInvoicesParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetInvoicesParametersQueryStatus'EnumDraft
Represents the JSON value "draft"
GetInvoicesParametersQueryStatus'EnumOpen
Represents the JSON value "open"
GetInvoicesParametersQueryStatus'EnumPaid
Represents the JSON value "paid"
GetInvoicesParametersQueryStatus'EnumUncollectible
Represents the JSON value "uncollectible"
GetInvoicesParametersQueryStatus'EnumVoid
Represents the JSON value "void"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

datadata GetInvoicesResponse

Represents a response of the operation getInvoices.

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

Constructors

GetInvoicesResponseError String
Means either no matching case available or a parse error
GetInvoicesResponse200 GetInvoicesResponseBody200
Successful response.
GetInvoicesResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetInvoicesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

datadata GetInvoicesResponseBody200

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

Constructors

GetInvoicesResponseBody200
- getInvoicesResponseBody200Data :: [Invoice]
  data
- getInvoicesResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getInvoicesResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/invoices'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetInvoicesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
Show GetInvoicesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
FromJSON GetInvoicesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices
ToJSON GetInvoicesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetInvoices

valuemkGetInvoicesResponseBody200

:: [Invoice]
getInvoicesResponseBody200Data
-> Bool
getInvoicesResponseBody200HasMore
-> Text
getInvoicesResponseBody200Url
-> GetInvoicesResponseBody200

Create a new GetInvoicesResponseBody200 with all required fields.