Lister les abonnements avec l'API Stripe

Liste les abonnements, du plus récent au plus ancien, éventuellement pour un client, un prix ou un statut. Sans status, les abonnements résiliés sont exclus. Chaque abonnement contient ses prix dans items.data. Paginez avec starting_after tant que has_more vaut true.

Identifiant
stripe_list_subscriptions

L'appel

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

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

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
customerstringNonOnly the subscriptions of this customer, the cus_ id from Search customers.
pricestringNonOnly the subscriptions with this price, the price_ id in items.data.price.id of a subscription returned by List subscriptions or Search subscriptions.
statusstringNonOnly the subscriptions in this status. all includes the canceled ones, and ended means canceled or incomplete_expired.Valeurs : active, all, canceled, ended, incomplete, incomplete_expired, past_due, paused, trialing, unpaid
limitintegerNonSubscriptions per page, from 1 to 100. The default is 10.
starting_afterstringNonId of the last subscription of the previous page, 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_list_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.