POST

Query Subscription Contracts


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 subscription contracts, given the provided paging, filtering, and sorting.

Query Subscription Contracts runs with these defaults, which you can override:

  • id is sorted in ASC order
  • cursorPaging.limit is 50

You can filter and sort by id and buyerInfo.contactId. For example, to retrieve all of a buyer's subscription contracts, filter by buyerInfo.contactId.

To learn about working with Query methods, see API Query Language and Sorting and Paging.

PropertyFiltersSort
id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
buyerInfo.contactId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permission Scopes
Read subscription contracts
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/subscription-contracts/v1/subscription-contracts/query

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?