getCommercePlanList method

Future<PaginatedCommercePlanResponse?> getCommercePlanList({ bool? paginated, int? limit, int? offset, String? payerType, })

List all billing plans

Returns a list of all billing plans for the instance. The plans are returned sorted by creation date, with the newest plans appearing first. This includes both free and paid plans. 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 payerType: Filter plans by payer type

Implementation

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