Read all subscriptions

get

https://api.loopsubscriptions.com/admin/2023-10/subscription

This endpoint allows you to retrieves a list of all subscriptions.

Query Params

pageNo

int32

The page number to fetch in a paginated response.

pageSize

string

Defaults to 50

The number of records to return per page. Maximum - 100

updatedAtStartEpoch

int32

Start of the time range (in epoch) for filtering customers based on their last update time.

updatedAtEndEpoch

int32

End of the time range (in epoch) for filtering customers based on their last update time.

status

string

enum

Filters subscriptions by status (e.g., Active, cancelled, paused, expired)

Allowed:

nextBillingStartEpoch

int32

Start of the time range (in epoch) for filtering subscriptions based on their next billing date.

nextBillingEndEpoch

int32

End of the time range (in epoch) for filtering subscriptions based on their next billing date.

lastInventoryAction

string

enum

Filters subscriptions by their last order status (e.g., Skipped, delayed or partially billed)

Allowed:

createdAtStartEpoch

int32

Start of the time range (in epoch) for filtering subscriptions based on their createdAt date.

createdAtEndEpoch

int32

End of the time range (in epoch) for filtering subscriptions based on their createdAt date.

lastPaymentStatus

string

enum

Filter subscriptions by their last order payment status. This filter is used to filter subscriptions that are in dunning.

Allowed:

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200