Stripe: Search subscriptions

← Subscriptions operations · Get started

Operation stripe.getsubscriptionssearch

Provider route: GET /v1/subscriptions/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["subscriptions"]["getSubscriptionsSearch"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.subscriptions.getSubscriptionsSearch(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.subscriptions.get_subscriptions_search(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.page	string	Optional	Maximum length: 5000
query.query	string	Required within parent	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Pause a subscription — response body
has_more	boolean	Required within parent
next_page	JSON	Optional
next_page (anyOf 1)	string	Alternative	Maximum length: 5000
next_page (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Known values: search_result
total_count	JSON	Optional
total_count (anyOf 1)	integer	Alternative	The total number of objects that match the query, only accurate up to 10,000.
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
url	string	Required within parent	Maximum length: 5000

Referenced models: Pause a subscription — response body

Schemas

705 more schemas are linked from the tables above, on the schema pages.

Create an account — response body

Field	Type	Presence	Description and constraints
$	object	Root	For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).
business_profile	JSON	Optional
business_profile (anyOf 1)	JSON	Alternative	Business information about the account.
business_profile (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url
business_profile (anyOf 2)	null	Alternative
business_type	JSON	Optional
business_type (anyOf 1)	string	Alternative	The business type. Known values: company, government_entity, individual, non_profit
business_type (anyOf 2)	null	Alternative
capabilities	Model	Optional	Expand Create an account — response body — capabilities
charges_enabled	boolean	Optional	Whether the account can process charges.
company	Model	Optional	Expand Create an account — response body — company
controller	Model	Optional	Expand Create an account — response body — controller
country	string	Optional	The account's country. Maximum length: 5000
created	JSON	Optional
created (anyOf 1)	integer	Alternative	Time at which the account was connected. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default_currency	string	Optional	Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). Maximum length: 5000
details_submitted	boolean	Optional	Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.
email	JSON	Optional
email (anyOf 1)	string	Alternative	An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. Maximum length: 5000
email (anyOf 2)	null	Alternative
external_accounts	object	Optional	External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.
external_accounts.data	array	Required within parent	The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
external_accounts.data[]	JSON	Each item
external_accounts.data[] (anyOf 1)	Model	Alternative	Expand Retrieve a bank account — response body
external_accounts.data[] (anyOf 2)	Model	Alternative	Expand Retrieve a card — customers get Customers Customer Cards Id — response body
external_accounts.has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
external_accounts.object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
external_accounts.url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000
future_requirements	Model	Optional	Expand Create an account — response body — future requirements
groups	JSON	Optional
groups (anyOf 1)	JSON	Alternative	The groups associated with the account.
groups (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create an account — response body — groups The groups associated with the account payments pricing
groups (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
individual	Model	Optional	Expand Create a person — accounts post Accounts Account People — response body
metadata	object	Optional	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: account
payouts_enabled	boolean	Optional	Whether the funds in this account can be paid out.
requirements	Model	Optional	Expand Create an account — response body — requirements
settings	JSON	Optional
settings (anyOf 1)	JSON	Alternative	Options for customizing how the account functions within Stripe.
settings (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury
settings (anyOf 2)	null	Alternative
tos_acceptance	Model	Optional	Expand Create an account — response body — tos acceptance
type	string	Optional	The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. Known values: custom, express, none, standard

Referenced models: Create an account — response body — business profile Business information about the account annual revenue, estimated worker count, mcc, minority owned business designation, monthly estimated revenue, name, product description, specified commercial transactions act url, support address, support email, support phone, support url, url, Create an account — response body — capabilities, Create an account — response body — future requirements, Create an account — response body — groups The groups associated with the account payments pricing, Create an account — response body — requirements, Create an account — response body — settings value bacs debit payments, branding, card issuing, card payments, dashboard, invoices, payments, payouts, paypay payments, sepa debit payments, treasury, Create an account — response body — tos acceptance, Create an account — response body — controller, Retrieve a bank account — response body, Retrieve a card — customers get Customers Customer Cards Id — response body, Create an account — response body — company, Create a person — accounts post Accounts Account People — response body

PostApplicationFeesIdRefund — response body — application / object: application

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the application. Maximum length: 5000
name (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: application

Accept a quote — response body — application / value / deleted: True, object: application

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the application. Maximum length: 5000
name (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: application

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

SDK function policy ID: stripe.getsubscriptionssearch. Catalog operation: GetSubscriptionsSearch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source