getBillingStatementPaymentAttempts method

Future<PaginatedBillingPaymentAttemptResponse?> getBillingStatementPaymentAttempts(String statementID, { bool? paginated, int? limit, int? offset, })

List payment attempts for a billing statement

Returns a list of all payment attempts for a specific billing statement. The payment attempts are returned sorted by creation date, with the newest payment attempts appearing first. Pagination is supported.

Parameters:

• String statementID (required): The ID of the statement to retrieve payment attempts for.

• bool paginated: Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

• int limit: Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

• int offset: Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Implementation

Future<PaginatedBillingPaymentAttemptResponse?>
    getBillingStatementPaymentAttempts(
  String statementID, {
  bool? paginated,
  int? limit,
  int? offset,
}) async {
  final response = await getBillingStatementPaymentAttemptsWithHttpInfo(
    statementID,
    paginated: paginated,
    limit: limit,
    offset: offset,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'PaginatedBillingPaymentAttemptResponse',
    ) as PaginatedBillingPaymentAttemptResponse;
  }
  return null;
}