ListPlansOptions class

Options for listing and filtering subscription plans.

This class provides various filtering and pagination options for retrieving plan lists from Paystack. All parameters are optional and can be combined to create specific queries.

Example usage:

final listOptions = ListPlansOptions(
  status: 'active',
  interval: 'monthly',
  perPage: 50,
  page: 1,
);

Mixed-in types

• ListPlansOptionsMappable

Annotations

• @MappableClass.new()

Constructors

ListPlansOptions({int? perPage, int? page, String? status, String? interval, int? amount, String? currency})

Creates a new ListPlansOptions instance.

const

Properties

amount → int?

Filter by specific plan amount (in smallest currency unit).

final

copyWith → ListPlansOptionsCopyWith<ListPlansOptions, ListPlansOptions, ListPlansOptions>

no setter, inherited

currency → String?

Filter by plan currency.

final

hashCode → int

The hash code for this object.

no setter, inherited

interval → String?

Filter by billing interval.

final

page → int?

Page number to retrieve (1-based).

final

perPage → int?

Number of plans to return per page.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → String?

Filter by plan status.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → String

inherited

toMap() → Map<String, dynamic>

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited