v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Read all subscriptions

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

get/2023-10/subscription

Query parameters

pageNointeger

The page number to fetch in a paginated response.

pageSizestring

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

updatedAtStartEpochinteger

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

updatedAtEndEpochinteger

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

status'ACTIVE' | 'CANCELLED' | 'PAUSED' | 'EXPIRED'

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

nextBillingStartEpochinteger

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

nextBillingEndEpochinteger

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

lastInventoryAction'SKIPPED' | 'DELAYED' | 'PARTIAL_BILLED'

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

createdAtStartEpochinteger

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

createdAtEndEpochinteger

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

lastPaymentStatus'SUCCESS' | 'FAILED'

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

Response

200