Skip to content

Latest commit

 

History

History
144 lines (95 loc) · 7.72 KB

stripe-deploy.md

File metadata and controls

144 lines (95 loc) · 7.72 KB
Raw

Deploy demo with Stripe

In this tutorial, you'll deploy the demo Stripe account and learn how to:

[!div class="checklist"]

  • Set up a Stripe account, the required PowerShell and az cli tools, an Azure subscription, and a service principal on Azure.
  • Deploy the Azure resources using either Azure portal or PowerShell.
  • Make your deployment visible to consumers by publishing the Azure developer portal.
  • Initialize the Stripe products and prices.

Pre-requisites

To prepare for this demo, you'll need to:

[!div class="checklist"]

  • Create a Stripe account.
  • Install and set up the required PowerShell and Azure CLI tools.
  • Set up an Azure subscription.
  • Set up a service principal in Azure.

Create a Stripe account

  1. Once you've created a Stripe account, navigate to the Developers tab in the Stripe dashboard.

  2. Use the API keys menu to create the following two API keys with specific permissions on different APIs.

    Key name Description Permissions
    Initialization key Use to initialize Stripe with products, prices, and webhooks
    • Products: write
    • Prices: write
    • Webhook endpoints: write
    App key Used by application to create checkout sessions, subscriptions, and payments for consumers
    • Checkout sessions: write
    • Subscriptions: write
    • Usage records: write
    • Prices: read
    • Products: read

Install and set up the required tools

Set up an Azure subscription with admin access

For this sample project, you will need admin access in order to deploy all the included artifacts to Azure. If you do not have an Azure subscription, set up a free trial.

Set up a service principal on Azure

For the solution to work, the Web App component needs a privileged credential on your Azure subscription with the scope to execute read operations on API Management (get products, subscriptions, etc.).

Before deploying the resources, set up the service principal in the Azure Active Directory (AAD) tenant used by the Web App to update the status of API Management subscriptions.

The simplest method is using the Azure CLI.

  1. Sign in with Azure CLI:

    az login

  2. Create an Azure service principal with the Azure CLI:

    az ad sp create-for-rbac --name <chosen-name-for-your-service-principal> --skip-assignment

  3. Take note of the name (ID), appId (client ID) and password (client secret), as you will need to pass these values as deployment parameters.

  4. Retrieve the object ID of your new service principal for deployment:

    az ad sp show --id <appId-of-service-principal> --query '{displayName: displayName, appId: appId, objectId: id}'

The correct role assignments for the service principal will be assigned as part of the deployment.

Deploy the Azure monetization resources

You can deploy the monetization resource via either Azure portal or PowerShell script.

Note

For both options, when filling in parameters, leave the adyen* parameters blank.

Azure portal

Click the button below to deploy the example to Azure and fill in the required parameters in the Azure portal.

Deploy to Azure

PowerShell script

You can deploy by running the deploy.ps1 PowerShell script at the root of the repo.

  1. Provide a parameters file for the main.json ARM template.

    • Find a template for the parameters file provider in output/main.parameters.template.json.
    • Rename this JSON file to output/main.parameters.json and update the values as necessary.

  2. Execute the deploy.ps1 script:

    deploy.ps1 `
-TenantId "<azure-ad-tenant-id>" `
-SubscriptionId "<azure-subscription-id>" `
-ResourceGroupName "apimmonetization" `
-ResourceGroupLocation "uksouth" `
-ArtifactStorageAccountName "<name-of-artifact-storage-account>"

Publish the API Management developer portal

This example project uses the hosted API Management developer portal.

You are required to complete a manual step to publish and make the resources visible to customers. See the Publish the portal for instructions.

Initialize Stripe products and prices

Once you've deployed the billing portal, the API Management service, and the products defined within API Management, you'll need to initialize the products in Stripe. Use the Stripe initialization PowerShell script.

  1. Run the script using the following parameters:

    ./payment/stripeInitialisation.ps1 `
    -StripeApiKey "<the 'Initialization Key' API key (see pre-requisites)>" `
    -ApimGatewayUrl "<the gateway URL of the APIM service - can find in Azure Portal>" `
    -ApimSubscriptionKey "<the primary key for the Built-in all-access subscription in APIM - can find in Azure Portal>" `
    -StripeWebhookUrl "https://<the URL of the billing portal App Service>/webhook/stripe" `
    -AppServiceResourceGroup "<the name of the resource group containing the billing portal App Service>" `
    -AppServiceName "<the name of the billing portal App Service>"

  2. The script makes two API calls:

    • To retrieve the API Management products.
    • To retrieve the monetization model definitions.

  3. For each of the monetization models defined, the script:

    • Finds the corresponding APIM product.
    • Uses the Stripe CLI to create a Stripe product.
    • For that Stripe product, creates the corresponding price for the model.

  4. The script:

    • Creates a webhook in Stripe to listen for:
      • Stripe subscription created events (to create API Management subscriptions when a consumer completes checkout).
      • Failed/cancelled Stripe subscription events (to deactivate API Management subscriptions when consumers cease payment).
    • Adds the secret for webhook connection to the billing portal app settings, so that the app can attach listeners and handle these events.

Next Steps