Définir une version de l'API Stripe

Suivez ces instructions pour garantir la cohérence des versions d'API dans l'ensemble de votre intégration Stripe.

Votre compte dispose d’une version d’API par défaut, qui définit la manière dont vous appelez l’API, les fonctionnalités auxquelles vous avez accès et les éléments de réponse que vous pouvez obtenir. Les objets d’événement webhook dépendent de votre version d’API par défaut, qui peut être différente de la version d’API utilisée par le SDK. Pour que ces versions correspondent, nous vous recommandons d’enregistrer un endpoint de webhook avec la même version d’API que celle utilisée par le SDK. Pour trouver votre version, consultez la section Afficher les versions de l’API utilisées par les requêtes API.

Notions de base sur la gestion des versions

Choisissez la langue de votre SDK pour démarrer.

Configuration de la version d’API

La bibliothèque stripe-ruby vous permet de définir la version de l’API globalement ou par requête. Si vous ne définissez pas de version d’API, les versions récentes de stripe-ruby utiliseront la version d’API la plus récente au moment de la publication de votre version de stripe-ruby. Les versions de stripe-ruby antérieures à la v9 utilisent la version d’API par défaut de votre compte.

Pour définir la version de l’API de manière globale avec le SDK, attribuez la version à la propriété Stripe.api_version :

require 'stripe'
Stripe.api_key =sk_test_BQokikJOvBiI2HlWgH4olfQ2
Stripe.api_version = '2025-02-24.acacia'

Ou définissez la version par requête :

require 'stripe'
intent = Stripe::PaymentIntent.retrieve(
  'pi_1DlIVK2eZvKYlo2CW4yj5l2C',
  {
    stripe_version: '2025-02-24.acacia',
  }
)
intent.capture

Remarque

Lorsque vous remplacez la version globalement ou par requête, les objets de réponse de l’API sont également renvoyés dans cette version.

Mise à niveau de la version de votre API

Avant de mettre à niveau la version de votre API, consultez attentivement les ressources suivantes :

Vous pouvez mettre à niveau la version d’API par défaut de votre compte dans Workbench. Mettez à jour votre code de façon à utiliser la dernière version du SDK Ruby et définissez la nouvelle version d’API lorsque vous effectuez vos appels.

Voir aussi

Les SDK Stripe suivent leur propre politique de gestion des versions. Consultez le lien ci-dessous pour en savoir plus.

Politiques de prise en charge et de gestion des versions Stripe