Search for savings plans

List all savings plans with the possibility to filter by different identifiers like savings plan id, asset id, user id and status.

SecuritybearerAuth
Request
query Parameters
id
string <uuid>

Search for savings plans by ID

Example: id=1eda5f65-eb10-64ce-b872-0242ac12000b
user_id
string <uuid>

Search for savings plans by user_id

Example: user_id=5b2ca85b-0191-4e93-9165-413df4aa0c18
asset_id
integer

Search for savings plans by asset_id

Example: asset_id=1
status
string

Search for savings plans by status.

Enum: "active" "canceled"
Example: status=active
page_size
integer

Number of elements to be displayed on a page

Example: page_size=10
page
integer

Display page number

Example: page=1
Responses
200

Success Response

401

Unauthorized

405

Not Allowed

422

Validation Error

429

Too Many Requests

500

Internal Error

503

Maintenance or Service unavailable

get/v1/savings-plan
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}