Stripe
======

Backend class
-------------

For Django, add this class path to ``AUTHENTICATION_BACKENDS``. For other
integrations, use the same class path in the framework-specific backend
setting.

.. list-table::
   :header-rows: 1

   * - Backend name
     - Class path
   * - ``stripe``
     - ``social_core.backends.stripe.StripeOAuth2``

Stripe uses OAuth2 for its authorization service. To setup Stripe backend:

- Register a new application at `Stripe App Creation`_, and

- Grab the ``client_id`` value in ``Applications`` tab and fill the ``App Id``
  setting::

    SOCIAL_AUTH_STRIPE_KEY = 'ca_...'

- Grab the ``Test Secret Key`` in the ``API Keys`` tab and fill the ``App
  Secret`` setting::

    SOCIAL_AUTH_STRIPE_SECRET = '...'

- Define ``SOCIAL_AUTH_STRIPE_SCOPE`` with the desired scope (options are
  ``read_only`` and ``read_write``)::

    SOCIAL_AUTH_STRIPE_SCOPE = ['read_only']

- Add the needed backend to ``AUTHENTICATION_BACKENDS``::

    AUTHENTICATION_BACKENDS = (
        ...
        'social_core.backends.stripe.StripeOAuth2',
        ...
    )

More info on Stripe OAuth2 at `Integrating OAuth`_.

.. _Stripe App Creation: https://manage.stripe.com/#account/applications/settings
.. _Integrating OAuth: https://stripe.com/docs/connect/oauth