Search subscriptions

Changed on

Search for subscriptions you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

get/v1/subscriptions/search

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/subscriptions/search
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

pagestring

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

querystring required

The search query string. See search query language and the list of supported query fields for subscriptions.

Response

Successful response.

has_moreboolean required
next_pagestring nullable
object'search_result' required

String representing the object's type. Objects of the same type share the same value.

total_countinteger

The total number of objects that match the query, only accurate up to 10,000.

urlstring required

Changes

  • 7cff4cc46d06Revision changes
    • warning

      added the new final_payment_failure enum value to the ///// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ///// response property for the response status

  • 8c89b982e519Revision changes
    • info

      added the optional property // to the response with the status

Some revisions have not been checked yet.