Search Subscriptions

Searches your subscriptions, with filters, sorting and paging.

Results come from a search index and can lag a few seconds behind the latest change; use Get Subscription before acting
on a status. Filter on status (for example OVERDUE) to find subscriptions that need attention.

Filterable and sortable fields: id, merchantId, userId, userEmail, subscriptionPlanId, subscriptionPlanName,
subscribeDate, checkoutInstrumentId, instrumentType, schedule.interval, schedule.intervalCount, amount.value,
amount.wholeValue, amount.currency, status, nextPaymentDate, termsOfServiceUrl, privacyPolicyUrl,
auditInfo.createdAt, auditInfo.createdBy, auditInfo.updatedAt, auditInfo.updatedBy.

Permission: Merchant Read.

Errors

  • 400 VALIDATION_ERROR: a filter or sort names a field that is not listed above, or paging is out of range.
  • 400 INVALID_REQUEST: the search could not be run, for example because a value does not match the field type.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A search request: an optional filter, an optional sort, and the page to return.

SearchAllConditions<SubscriptionSearchField> | SearchAnyConditions<SubscriptionSearchField>

Conditions a record must match. Omit to return every record. Use all for AND and any for OR; groups can be nested.

sort
array of objects

Sort order, applied in the order listed.

sort
number
10 to 1000
Defaults to 100

Records per page, between 10 and 1000. Defaults to 100. page × pageSize cannot exceed 10,000; narrow the filter to reach
older records.

number
≥ 1
Defaults to 1

Page to return, starting at 1. Defaults to 1.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json