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

    Interface GetSubscriptionsQuery

    Query parameters for sb.subscriptions.list().

    interface GetSubscriptionsQuery {
        "createDate[gte]"?: string;
        "createDate[lte]"?: string;
        customerRef?: string;
        limit?: number;
        locationRef?: string;
        nextPageToken?: string;
        order?: string;
        planRef?: string;
        status?: string;
    }
    Index
    createDate[gte]? createDate[lte]? customerRef? limit? locationRef? nextPageToken? order? planRef? status?
    "createDate[gte]"?: string

    Filter subscriptions created on or after this date (ISO 8601). Use with createDate[lte] for a range.

    "createDate[lte]"?: string

    Filter subscriptions created on or before this date (ISO 8601). Use with createDate[gte] for a range.

    customerRef?: string

    UUID of the customer whose subscriptions to list.

    limit?: number

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

    locationRef?: string

    UUID of the location whose subscriptions to list.

    nextPageToken?: string

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

    order?: string

    Sort order for results.

    planRef?: string

    UUID of the plan to filter subscriptions by.

    status?: string

    Filter by subscription status. Comma-separated values, e.g. active,scheduled. Defaults to active, scheduled, and incomplete when omitted.

    Supported values:

    • active — currently active
    • scheduled — scheduled to start
    • incomplete — pending setup or payment
    • incompleteExpired — incomplete and expired
    • canceled — canceled

    Settings
    Member Visibility

    On This Page
    Properties