getBillingPriceList method

Future<PaginatedBillingPriceResponse?> getBillingPriceList({ bool? paginated, int? limit, int? offset, String? planId, })

List all billing prices

Returns a list of all prices for the instance. The prices are returned sorted by amount ascending, then by creation date descending. This includes both default and custom prices. Pagination is supported.

Parameters:

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

• String planId: Filter prices by plan ID

Implementation

Future<PaginatedBillingPriceResponse?> getBillingPriceList({
  bool? paginated,
  int? limit,
  int? offset,
  String? planId,
}) async {
  final response = await getBillingPriceListWithHttpInfo(
    paginated: paginated,
    limit: limit,
    offset: offset,
    planId: planId,
  );
  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),
      'PaginatedBillingPriceResponse',
    ) as PaginatedBillingPriceResponse;
  }
  return null;
}