Action: Create Checkout Session

Stripe Operation

The Create Checkout Session action enables users to create a Stripe checkout session.

Example User Story

I want to create a Stripe checkout session when a user selects to buy one of our products on our website.

Fields

Field Name	Field Type	Required
customer_email	String	Yes
line_items	Array	Yes
success_url	String	Yes
cancel_url	String	Yes
mode	String	No

Related Connections

Stripe

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-checkout-session",
  "state": "inDev",
  "meta": {
    "short": "Create Checkout Session",
    "description": "Creates a new checkout session in Stripe for payment processing."
  },
  "input": [
    {
      "name": "customer_email",
      "type": "String",
      "required": true,
      "meta": {
        "description": "Email address of the customer."
      }
    },
    {
      "name": "line_items",
      "type": "Array",
      "required": true,
      "meta": {
        "description": "List of items the customer is purchasing."
      }
    },
    {
      "name": "success_url",
      "type": "String",
      "required": true,
      "meta": {
        "description": "URL to redirect to after successful payment."
      }
    },
    {
      "name": "cancel_url",
      "type": "String",
      "required": true,
      "meta": {
        "description": "URL to redirect to if the customer cancels the payment."
      }
    },
    {
      "name": "mode",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The mode of the checkout session (e.g., 'payment', 'subscription').",
        "default": "payment"
      }
    }
  ],
  "output": [
    {
      "name": "session_id",
      "type": "String",
      "selector": ["id"],
      "meta": {
        "description": "The unique identifier for the checkout session."
      }
    },
    {
      "name": "session_url",
      "type": "String",
      "selector": ["url"],
      "meta": {
        "description": "The URL to redirect the customer to for payment."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v1/checkout/sessions",
        "headers": {
          "Content-Type": "application/x-www-form-urlencoded"
        },
        "bodyTemplate": {
          "value": "customer_email={{.customer_email}}&line_items={{.line_items}}&success_url={{.success_url}}&cancel_url={{.cancel_url}}&mode={{.mode}}",
          "placeholders": [
            {
              "name": "apiKey",
              "type": "String",
              "description": "Stripe API key for authentication.",
              "required": true
            },
            {
              "name": "customer_email",
              "type": "String",
              "description": "Email address of the customer.",
              "required": true
            },
            {
              "name": "line_items",
              "type": "Array",
              "description": "List of items the customer is purchasing.",
              "required": true
            },
            {
              "name": "success_url",
              "type": "String",
              "description": "URL to redirect to after successful payment.",
              "required": true
            },
            {
              "name": "cancel_url",
              "type": "String",
              "description": "URL to redirect to if the customer cancels the payment.",
              "required": true
            },
            {
              "name": "mode",
              "type": "String",
              "description": "The mode of the checkout session (e.g., 'payment', 'subscription').",
              "required": false,
              "default": "payment"
            }
          ]
        }
      }
    }
  ]
}