Extension SDK API reference

UI extensions have access to context props and utility functions that let them interact with an app’s users and the Stripe Dashboard ecosystem. This page documents these values and functions.

Props

Views are passed props that the extension can use for context on where the extension is being displayed. Your view can take some or all of these props as arguments, and they’re of type ExtensionContextValue.

import type {ExtensionContextValue} from '@stripe/ui-extension-sdk/context';

const ExampleApp = ({ userContext, environment, oauthContext, appContext}: ExtensionContextValue) => {
  ...
}

User context

The userContext prop has data about the end user using your app, including these fields:

RoleDefinition

A role definition has these fields:

Environment

The environment prop has data about the page a user is viewing, including these fields:

OAuth context

The oauthContext prop contains information about the current OAuth workflow, if one is underway.

App context

The appContext prop contains information about the user’s app install, and has the following fields:

Utility functions

The UI extension SDK provides these functions to help apps interact with the Stripe API and the Dashboard user.

• clipboardWriteText—Write text to the end user’s clipboard.
• createHttpClient-Get an authenticated Stripe API client.
• createOAuthState—Obtain values to use when you create an authorization link in an OAuth workflow.
• fetchStripeSignature—Get a signature from Stripe’s servers.
• getDashboardUserEmail—Get the end user’s email address.
• getUserAuthorizedPermissions – Get the intersection of the app’s authorised permissions and those of the current Dashboard user.
• isPermissionAuthorized – Indicate whether a permission is currently in an app’s authorised permissions.
• isSourceInAuthorizedCSP – Indicate whether a URL is currently in an app’s authorised content security policy.
• showToast—Show a toast message to the user.
• useRefreshDashboardData – Enable your view to update data in the Dashboard.

clipboardWriteText

Write text to the app user’s clipboard. The user can then paste it as if they had copied it.

To use this function, first import it from the SDK:

import {clipboardWriteText} from '@stripe/ui-extension-sdk/utils';

For example, provide a button that copies Hello, world! to the clipboard when pressed. In a real app, you could use this to copy an address, invoice number, or other important detail.

import {useCallback} from 'react';
import {Button} from '@stripe/ui-extension-sdk/ui';
import {clipboardWriteText} from '@stripe/ui-extension-sdk/utils';

const App = () => {
  const writeToClipboard = useCallback(async () => {
    try {
      await clipboardWriteText('Hello, world!');
      // Writing to the clipboard succeeded
    } catch (e) {
      // Writing to the clipboard failed
    }
  }, []);
  return (
    <Button
      onPress={writeToClipboard}
    >
      Copy to clipboard
    </Button>
  );
};

createHttpClient

Obtain an authenticated Stripe API client for the installed user’s account. You must use the STRIPE_API_KEY provided by the SDK to give your client the permissions defined in the app manifest.

To use this function, first import it from the SDK and then provide its values to the Stripe constructor from stripe-node.

import {createHttpClient, STRIPE_API_KEY} from '@stripe/ui-extension-sdk/http_client';
import Stripe from 'stripe';

const stripe = new Stripe(
  STRIPE_API_KEY,
  {
    httpClient: createHttpClient(),
    apiVersion: '2022-11-15'
  }
)

For an example in context, see Build a UI.

createOAuthState

Obtain state and challenge values to use when you create an authorisation link in an OAuth workflow.

To use this function, first import it from the SDK.

import {createOAuthState} from '@stripe/ui-extension-sdk/utils';

For an example in context, see Add authorisation workflows.

fetchStripeSignature

Get a signature from Stripe’s servers. Your UI extension can use this signature to send signed requests to your app’s backend.

To use this function, first import it from the SDK.

import {fetchStripeSignature} from '@stripe/ui-extension-sdk/utils';

For more details and an example in context, see server-side logic docs.

getDashboardUserEmail

Get the app user’s email address.

To use this function, first import it from the SDK.

import {getDashboardUserEmail} from '@stripe/ui-extension-sdk/utils';

You must also include the user_email_read permission in your app manifest. Add it using a CLI command or edit the app manifest file directly.

stripe apps grant permission user_email_read 
"EXPLANATION"

For example, access the app user’s email in a view by getting it using the getDashboardUserEmail function and storing it in a React state variable.

import {useEffect, useState} from 'react';
import {getDashboardUserEmail} from '@stripe/ui-extension-sdk/utils';

export const useDashboardUserEmail = () => {
  const [email, setEmail] = useState<string | null>(null);

  const fetchEmail = async () => {
    try {
      const {email} = await getDashboardUserEmail();
      setEmail(email);
    } catch(e) {
      console.error(e);
    }
  };

  useEffect(() => {
    fetchEmail();
  }, []);

  return email;
};

const App = () => {
  const dashboardUserEmail = useDashboardUserEmail();
  ...
};

getUserAuthorizedPermissions

Gets the intersection of the app’s authorised permissions and those of the current Dashboard user.

For instance, if the app’s current authorised permissions are event_read and charge_write, but the current Dashboard user has a view_only role (that is, no edit permissions), calling the function returns the array ['event_read'].

To use this function, first import it from the SDK.

import {getUserAuthorizedPermissions} from '@stripe/ui-extension-sdk/utils';

isPermissionAuthorized

Indicate if a permission is in the app’s authorised permissions. Throws an error if the permission isn’t on the app manifest.

To use this function, first import it from the SDK.

import {isPermissionAuthorized} from '@stripe/ui-extension-sdk/utils';

Gating functionality by permission

This function can gate app functionality by user authorised permissions.

For instance, on the customer details page, only update customer details if the app user has authorised the customer_write permission.

import {isPermissionAuthorized} from '@stripe/ui-extension-sdk/utils';

const App = () => {

  const updateCustomer = useCallback(async () => {

    const customerWriteEnabled = await isPermissionAuthorized('customer_write');
    if (customerWriteEnabled){
      await updateCurrentCustomer()
    }
    ...
  })
}

isSourceInAuthorizedCSP

Indicate if a URL is in the app’s authorised connect sources or image sources.

To use this function, first import it from the SDK.

import {isSourceInAuthorizedCSP} from '@stripe/ui-extension-sdk/utils';

showToast

Render a toast at the bottom of your view to inform the user about the status of an action. For example, a toast can show a user whether an API call succeeded or failed.

import {showToast} from '@stripe/ui-extension-sdk/utils';

const App = () => {
  const handleClick = () => {
    fetch(...)
      .then((response) => {
        showToast("Invoice updated", {type: "success"})
        return response.json()
      })
      .catch(() => {
        showToast("Invoice could not be updated", {type: "caution"})
      })
  }

  // Use the `handleClick`...
}

The showToast() function takes two arguments, a message and options. The function is defined as follows:

type ToastType = "success" | "caution" | "pending" | undefined;
type ToastOptions = { type?: ToastType; action?: string; onAction: () => void; }
(message: string, options?: ToastOptions) => Promise<{
    update: (updateMessage: string, updateOptions?: ToastOptions) => void;
    dismiss: () => void;
}>;

Toast messages can’t exceed 30 characters in length or be empty. If a message is too long or empty, the console logs an error.

Unless they’re of type pending, toasts dismiss automatically.

import {showToast} from '@stripe/ui-extension-sdk/utils';

const App = () => {
  const handleClick = async () => {
    const { dismiss, update } = await showToast("Refreshing data", {
      type: "pending",
    });
    try {
      await refreshData();
      dismiss();
    } catch (error) {
      update("Data could not be refreshed", { type: "caution" });
    }
  }

  // Use the `handleClick`...
}

Toasts can also prompt the user to take an action. Clicking the action button automatically dismisses the toast.

import {showToast} from '@stripe/ui-extension-sdk/utils';

const App = () => {
  const handleClick = async () => {
    let timeout;
    const { dismiss } = await showToast('Message "sent"', {
      action: "Undo",
      onAction: () => {
        clearTimeout(timeout);
        showToast('Message "unsent"');
      },
    });
    timeout = setTimeout(() => {
      sendMessage();
      dismiss();
    }, 3000);
  }

  // Use the `handleClick`...
}

useRefreshDashboardData

Enable your view to update data in the Dashboard. This function returns another callback function. Store that callback, and call it when Stripe data changes. When you call it, the Dashboard updates to reflect the new values.

To use this function, first import it from the SDK.

import {useRefreshDashboardData} from '@stripe/ui-extension-sdk/utils';

For instance, on a customer details page, get the callback function that refreshes Dashboard data, and then call it after updating the current customer.

import {useCallback} from 'react';
import {useRefreshDashboardData} from '@stripe/ui-extension-sdk/utils';

const App = () => {
  const refreshDashboardData = useRefreshDashboardData();

  const updateCustomer = useCallback(async () => {
    try {
      await updateCurrentCustomer();
      await refreshDashboardData();
    } catch (error) {}
  }, [refreshDashboardData]);
}