Stripe PHP

Public preview features are available in versions with a -beta.X suffix. You can install them via Composer by specifying the version. It is recommended to pin the version in your composer.json to avoid breaking changes between preview releases.

If a preview feature requires a specific Stripe-Version header (e.g., feature_beta=v3), use Stripe::addBetaVersion().

composer require stripe/stripe-php:v<replace-with-the-version-of-your-choice>

Stripe::addBetaVersion("feature_beta", "v3");

If you prefer not to use Composer, download the latest release from the GitHub releases page. To use the library, include the init.php file in your project.

require_once '/path/to/stripe-php/init.php';

The recommended way to install the Stripe PHP bindings is via Composer. This will automatically handle dependencies like curl, json, and mbstring.

composer require stripe/stripe-php

To contribute a new example to the stripe-php repository, follow these steps:

1. Clone ExampleTemplate.php to create your new file.
2. Implement your example logic.
3. Fill out the file comment block, ensuring you include a description and the key steps being demonstrated.
4. Run the script using php your_example.php to verify it works.

PHP Version Requirements

• Current: PHP 7.2.0 and later.
• Note: Support for PHP 7.2 and 7.3 is being phased out; it is recommended to upgrade to a newer runtime.

Required PHP Extensions

If installing manually, ensure the following extensions are enabled:

• curl (or provide a custom non-cURL client)
• json
• mbstring (Multibyte String)

To run an example script located in the examples/ directory, use the PHP CLI. For example, to run ThinEventWebhookHandler.php, execute the following command in your terminal from within the examples/ folder:

php ThinEventWebhookHandler.php

The modern way to interact with the Stripe API is by instantiating a \[Stripe\]StripeClient with your secret key. This follows the client/service pattern introduced in version 7.33.0.

$stripe = new \Stripe\StripeClient('sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$customer = $stripe->customers->create([
    'description' => 'example customer',
    'email' => 'email@example.com',
    'payment_method' => 'pm_card_visa',
]);
echo $customer;

To automatically retry requests that fail due to intermittent network problems, use \Stripe\Stripe::setMaxNetworkRetries(int $count). The library uses idempotency keys to ensure these retries are safe.

\Stripe\Stripe::setMaxNetworkRetries(2);

The library sends telemetry regarding request latency and feature usage to Stripe by default. To disable this, use \Stripe\Stripe::setEnableTelemetry(false).

\Stripe\Stripe::setEnableTelemetry(false);

If you need to use a custom CA certificate bundle instead of the library's internal one, use \Stripe\Stripe::setCABundlePath().

\Stripe\Stripe::setCABundlePath("path/to/ca/bundle");