@izak0s/spacebring-api - v7.1.0
    Preparing search index...

    Interface GetPlansQuery

    Query parameters for sb.plans.list().

    interface GetPlansQuery {
        entire?: string;
        limit?: number;
        locationRef?: string;
        nextPageToken?: string;
        resourceRef?: string;
    }
    Index
    entire? limit? locationRef? nextPageToken? resourceRef?
    entire?: string

    Only applies together with resourceRef. Filter the plans.tiers of GET /resources/v1/{resourceId} by their entire field instead. When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false.

    limit?: number

    Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

    locationRef?: string

    UUID of the location whose plans to list.

    nextPageToken?: string

    Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

    resourceRef?: string

    Read plans.tiers from GET /resources/v1/{resourceId} instead. UUID of the resource whose tier plans to list.

    Settings
    Member Visibility

    On This Page
    Properties