stripe-php

PHP library for the Stripe API.

3,687

847

3,687

View on GitHub

Top Related Projects

Slim

11,931

Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs.

Quick Overview

The stripe/stripe-php repository is the official PHP library for the Stripe payment processing platform. It provides a simple and secure way to interact with the Stripe API, allowing developers to integrate Stripe functionality into their PHP applications.

Pros

Comprehensive API Coverage: The library supports a wide range of Stripe features, including payments, subscriptions, customers, and more, making it a versatile tool for building payment-enabled applications.
Ease of Use: The library has a well-designed and intuitive API, making it easy for developers to get started and integrate Stripe functionality into their projects.
Actively Maintained: The repository is actively maintained by the Stripe team, with regular updates and bug fixes, ensuring the library remains up-to-date and secure.
Extensive Documentation: The Stripe documentation, including the PHP library documentation, is comprehensive and provides detailed guidance for developers.

Cons

Dependency on Stripe: The library is tightly coupled with the Stripe platform, which means that developers are locked into the Stripe ecosystem and may have difficulty switching to other payment providers in the future.
Limited Customization: While the library provides a lot of functionality, it may not offer the level of customization that some developers require, especially for more complex payment workflows.
Potential Performance Impact: Depending on the size and complexity of the application, the library's overhead may have a noticeable impact on performance, especially for high-traffic websites.
Pricing Complexity: Stripe's pricing model can be complex, with various fees and charges depending on the type of transactions and the features used, which may make it difficult for developers to accurately estimate the cost of using Stripe.

Code Examples

Here are a few examples of how to use the stripe/stripe-php library:

Creating a Customer:

\Stripe\Stripe::setApiKey('your_stripe_secret_key');

$customer = \Stripe\Customer::create([
    'email' => 'customer@example.com',
    'source' => 'tok_visa',
]);

echo $customer->id;

Charging a Customer:

$charge = \Stripe\Charge::create([
    'amount' => 1000,
    'currency' => 'usd',
    'customer' => $customer->id,
    'description' => 'Example charge',
]);

echo $charge->id;

Creating a Subscription:

$subscription = \Stripe\Subscription::create([
    'customer' => $customer->id,
    'items' => [
        ['price' => 'price_12345'],
    ],
]);

echo $subscription->id;

Handling Webhooks:

$webhook_secret = 'your_stripe_webhook_secret';

$payload = @file_get_contents('php://input');
$sig_header = $_SERVER['HTTP_STRIPE_SIGNATURE'];

try {
    $event = \Stripe\Webhook::constructEvent(
        $payload, $sig_header, $webhook_secret
    );
} catch(\UnexpectedValueException $e) {
    // Invalid payload
    http_response_code(400);
    exit();
} catch(\Stripe\Exception\SignatureVerificationException $e) {
    // Invalid signature
    http_response_code(400);
    exit();
}

// Handle the event
switch ($event->type) {
    case 'payment_intent.succeeded':
        $paymentIntent = $event->data->object;
        // ... handle the event
        break;
    // ... handle other event types
    default:
        // Unexpected event type
        http_response_code(400);
        exit();
}

http_response_code(200);

Getting Started

To get started with the stripe/stripe-php library, follow these steps:

Install the library using Composer:

composer require stripe/stripe-php

Set your Stripe API keys in your application:

\Stripe\Stripe::setApiKey('your_stripe_secret_key');

Integrate Stripe functionality into your application, such as creating customers, charging cards

Competitor Comparisons

Slim

11,931

Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs.

Pros of Slim

Lightweight and flexible micro-framework for building web applications and APIs
Easy to learn and use, with a gentle learning curve
Extensive middleware ecosystem for adding functionality

Cons of Slim

Less comprehensive than full-stack frameworks, may require additional libraries for complex applications
Smaller community compared to more popular frameworks, potentially fewer resources and third-party integrations

Code Comparison

Slim (routing example):

$app = new \Slim\App();
$app->get('/hello/{name}', function ($request, $response, $args) {
    return $response->write("Hello, " . $args['name']);
});
$app->run();

Stripe PHP (API request example):

\Stripe\Stripe::setApiKey('sk_test_...');
$charge = \Stripe\Charge::create([
    'amount' => 2000,
    'currency' => 'usd',
    'source' => 'tok_visa',
    'description' => 'Example charge',
]);

While Slim is a web application framework focused on routing and middleware, Stripe PHP is a SDK for interacting with the Stripe API. Slim is more versatile for building various web applications, while Stripe PHP is specifically designed for integrating Stripe's payment processing functionality into PHP projects.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Stripe PHP bindings

The Stripe PHP library provides convenient access to the Stripe API from applications written in the PHP language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which makes it compatible with a wide range of versions of the Stripe API.

Requirements

PHP 5.6.0 and later.

Composer

You can install the bindings via Composer. Run the following command:

composer require stripe/stripe-php

To use the bindings, use Composer's autoload:

require_once 'vendor/autoload.php';

Manual Installation

If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the init.php file.

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

Dependencies

The bindings require the following extensions in order to work properly:

curl, although you can use your own non-cURL client if you prefer
json
mbstring (Multibyte String)

If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.

Getting Started

Simple usage looks like:

$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;

Client/service patterns vs legacy patterns

You can continue to use the legacy integration patterns used prior to version 7.33.0. Review the migration guide for the backwards-compatible client/services pattern changes.

Documentation

See the PHP API docs.

See video demonstrations covering how to use the library.

Legacy Version Support

PHP 5.4 & 5.5

If you are using PHP 5.4 or 5.5, you should consider upgrading your environment as those versions have been past end of life since September 2015 and July 2016 respectively. Otherwise, you can still use Stripe by downloading stripe-php v6.43.1 (zip, tar.gz) from our releases page. This version will work but might not support recent features we added since the version was released and upgrading PHP is the best course of action.

PHP 5.3

If you are using PHP 5.3, you should upgrade your environment as this version has been past end of life since August 2014. Otherwise, you can download v5.9.2 (zip, tar.gz) from our releases page. This version will continue to work with new versions of the Stripe API for all common uses.

Custom Request Timeouts

Note We do not recommend decreasing the timeout for non-read-only calls (e.g. charge creation), since even if you locally timeout, the request on Stripe's side can still complete. If you are decreasing timeouts on these calls, make sure to use idempotency tokens to avoid executing the same transaction twice as a result of timeout retry logic.

To modify request timeouts (connect or total, in seconds) you'll need to tell the API client to use a CurlClient other than its default. You'll set the timeouts in that CurlClient.

// set up your tweaked Curl client
$curl = new \Stripe\HttpClient\CurlClient();
$curl->setTimeout(10); // default is \Stripe\HttpClient\CurlClient::DEFAULT_TIMEOUT
$curl->setConnectTimeout(5); // default is \Stripe\HttpClient\CurlClient::DEFAULT_CONNECT_TIMEOUT

echo $curl->getTimeout(); // 10
echo $curl->getConnectTimeout(); // 5

// tell Stripe to use the tweaked client
\Stripe\ApiRequestor::setHttpClient($curl);

// use the Stripe API client as you normally would

Custom cURL Options (e.g. proxies)

Need to set a proxy for your requests? Pass in the requisite CURLOPT_* array to the CurlClient constructor, using the same syntax as curl_stopt_array(). This will set the default cURL options for each HTTP request made by the SDK, though many more common options (e.g. timeouts; see above on how to set those) will be overridden by the client even if set here.

// set up your tweaked Curl client
$curl = new \Stripe\HttpClient\CurlClient([CURLOPT_PROXY => 'proxy.local:80']);
// tell Stripe to use the tweaked client
\Stripe\ApiRequestor::setHttpClient($curl);

Alternately, a callable can be passed to the CurlClient constructor that returns the above array based on request inputs. See testDefaultOptions() in tests/CurlClientTest.php for an example of this behavior. Note that the callable is called at the beginning of every API request, before the request is sent.

Configuring a Logger

The library does minimal logging, but it can be configured with a PSR-3 compatible logger so that messages end up there instead of error_log:

\Stripe\Stripe::setLogger($logger);

Accessing response data

You can access the data from the last API response on any object via getLastResponse().

$customer = $stripe->customers->create([
    'description' => 'example customer',
]);
echo $customer->getLastResponse()->headers['Request-Id'];

SSL / TLS compatibility issues

Stripe's API now requires that all connections use TLS 1.2. Some systems (most notably some older CentOS and RHEL versions) are capable of using TLS 1.2 but will use TLS 1.0 or 1.1 by default. In this case, you'd get an invalid_request_error with the following error message: "Stripe no longer supports API requests made with TLS 1.0. Please initiate HTTPS connections with TLS 1.2 or later. You can learn more about this at https://stripe.com/blog/upgrading-tls.".

The recommended course of action is to upgrade your cURL and OpenSSL packages so that TLS 1.2 is used by default, but if that is not possible, you might be able to solve the issue by setting the CURLOPT_SSLVERSION option to either CURL_SSLVERSION_TLSv1 or CURL_SSLVERSION_TLSv1_2:

$curl = new \Stripe\HttpClient\CurlClient([CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1]);
\Stripe\ApiRequestor::setHttpClient($curl);

Per-request Configuration

For apps that need to use multiple keys during the lifetime of a process, like one that uses Stripe Connect, it's also possible to set a per-request key and/or account:

$customers = $stripe->customers->all([],[
    'api_key' => 'sk_test_...',
    'stripe_account' => 'acct_...'
]);

$stripe->customers->retrieve('cus_123456789', [], [
    'api_key' => 'sk_test_...',
    'stripe_account' => 'acct_...'
]);

Configuring CA Bundles

By default, the library will use its own internal bundle of known CA certificates, but it's possible to configure your own:

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

Configuring Automatic Retries

The library can be configured to automatically retry requests that fail due to an intermittent network problem:

\Stripe\Stripe::setMaxNetworkRetries(2);

Idempotency keys are added to requests to guarantee that retries are safe.

Telemetry

By default, the library sends telemetry to Stripe regarding request latency and feature usage. These numbers help Stripe improve the overall latency of its API for all users, and improve popular features.

You can disable this behavior if you prefer:

\Stripe\Stripe::setEnableTelemetry(false);

Beta SDKs

Stripe has features in the beta phase that can be accessed via the beta version of this package. We would love for you to try these and share feedback with us before these features reach the stable phase. Use the composer require command with an exact version specified to install the beta version of the stripe-php pacakge.

composer require stripe/stripe-php:v9.2.0-beta.1

Note There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your composer.json file. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.

We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version.

If your beta feature requires a Stripe-Version header to be sent, set the apiVersion property of config object by using the function addBetaVersion:

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

Support

New features and bug fixes are released on the latest major version of the Stripe PHP library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.

Development

Get Composer. For example, on Mac OS:

brew install composer

Install dependencies:

composer install

The test suite depends on stripe-mock, so make sure to fetch and run it from a background terminal (stripe-mock's README also contains instructions for installing via Homebrew and other methods):

go install github.com/stripe/stripe-mock@latest
stripe-mock

Install dependencies as mentioned above (which will resolve PHPUnit), then you can run the test suite:

./vendor/bin/phpunit

Or to run an individual test file:

./vendor/bin/phpunit tests/Stripe/UtilTest.php

Update bundled CA certificates from the Mozilla cURL release:

./update_certs.php

The library uses PHP CS Fixer for code formatting. Code must be formatted before PRs are submitted, otherwise CI will fail. Run the formatter with:

./vendor/bin/php-cs-fixer fix -v .

Attention plugin developers

Are you writing a plugin that integrates Stripe and embeds our library? Then please use the setAppInfo function to identify your plugin. For example:

\Stripe\Stripe::setAppInfo("MyAwesomePlugin", "1.2.34", "https://myawesomeplugin.info");

The method should be called once, before any request is sent to the API. The second and third parameters are optional.

SSL / TLS configuration option

See the "SSL / TLS compatibility issues" paragraph above for full context. If you want to ensure that your plugin can be used on all systems, you should add a configuration option to let your users choose between different values for CURLOPT_SSLVERSION: none (default), CURL_SSLVERSION_TLSv1 and CURL_SSLVERSION_TLSv1_2.

Top Related Projects

Slim

11,931

Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot