Rechercher des abonnements avec l'API Stripe

Recherche des abonnements par statut, date de création, date de résiliation ou metadata avec le langage de requête de recherche de Stripe, ce qui convient à des questions comme les abonnements nouveaux ou résiliés sur une période. La réponse contient data, has_more et next_page ; envoyez next_page comme page pour la page suivante.

Identifiant
stripe_search_subscriptions

L'appel

POST https://connect.reportei.com/api/tools/stripe_search_subscriptions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
querystringOuiUp to 10 clauses joined by AND or by OR, never both, for example status:"canceled". Fields: status (active, canceled, incomplete, incomplete_expired, past_due, paused, trialing, unpaid), metadata["key"]:"value", and created and canceled_at (Unix seconds), which also take a greater-than or less-than sign, optionally followed by an equals sign, in place of the colon. There is no customer field: use List subscriptions for one customer. Text values go in double quotes.
limitintegerNonSubscriptions per page, from 1 to 100. The default is 10.
pagestringNonThe next_page value of the previous response, to get the next page.

Connexions possibles

Votre client connecte son compte Stripe une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/stripe_search_subscriptions. Il devient la définition de tool de votre agent sans conversion.

Autres tools Stripe

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.