Action: Create a Payment Link

Stripe Operation

The Create a Payment Link action enables users to create a Stripe payment link for use in third-party applications.

Example User Story

I want to create a Stripe payment link in order to my website users start the payment process.

Fields

Field Name	Field Type	Required
lineItems	Array	Yes
afterCompletion	Object	No
automaticTax	Object	No
billingAddressCollection	String	No
consentCollection	Object	No
customText	Object	No
customerCreation	String	No
invoiceCreation	Object	No
metadata	Object	No
paymentIntentData	Object	No
paymentMethodCollection	String	No
paymentMethodTypes	Array	No
phoneNumberCollection	Object	No
shippingAddressCollection	Object	No
shippingOptions	Array	No
submitType	String	No
subscriptionData	Object	No
taxIdCollection	Object	No

Related Connections

Stripe

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-payment-link",
  "state": "inDev",
  "meta": {
    "short": "Create Payment Link",
    "description": "Creates a payment link in Stripe for a customer to complete a payment."
  },
  "input": [
    {
      "name": "lineItems",
      "type": "Array",
      "required": true,
      "meta": {
        "description": "Array of line items for the payment link."
      }
    },
    {
      "name": "afterCompletion",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Behavior after payment completion."
      }
    },
    {
      "name": "automaticTax",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Automatic tax configuration."
      }
    },
    {
      "name": "billingAddressCollection",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Billing address collection mode."
      }
    },
    {
      "name": "consentCollection",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Consent collection configuration."
      }
    },
    {
      "name": "customText",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Custom text for the payment link."
      }
    },
    {
      "name": "customerCreation",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Customer creation mode."
      }
    },
    {
      "name": "invoiceCreation",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Invoice creation configuration."
      }
    },
    {
      "name": "metadata",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Metadata for the payment link."
      }
    },
    {
      "name": "paymentIntentData",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Payment intent data."
      }
    },
    {
      "name": "paymentMethodCollection",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Payment method collection mode."
      }
    },
    {
      "name": "paymentMethodTypes",
      "type": "Array",
      "required": false,
      "meta": {
        "description": "Array of payment method types."
      }
    },
    {
      "name": "phoneNumberCollection",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Phone number collection configuration."
      }
    },
    {
      "name": "shippingAddressCollection",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Shipping address collection configuration."
      }
    },
    {
      "name": "shippingOptions",
      "type": "Array",
      "required": false,
      "meta": {
        "description": "Array of shipping options."
      }
    },
    {
      "name": "submitType",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Submit type for the payment link."
      }
    },
    {
      "name": "subscriptionData",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Subscription data."
      }
    },
    {
      "name": "taxIdCollection",
      "type": "Object",
      "required": false,
      "meta": {
        "description": "Tax ID collection configuration."
      }
    }
  ],
  "output": [
    {
      "name": "paymentLink",
      "type": "Object",
      "selector": ["payment_link"],
      "meta": {
        "description": "The created payment link object."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v1/payment_links",
        "headers": {
          "Content-Type": "application/x-www-form-urlencoded"
        },
        "bodyTemplate": {
          "value": "line_items={{.lineItems}}&after_completion={{.afterCompletion}}&automatic_tax={{.automaticTax}}&billing_address_collection={{.billingAddressCollection}}&consent_collection={{.consentCollection}}&custom_text={{.customText}}&customer_creation={{.customerCreation}}&invoice_creation={{.invoiceCreation}}&metadata={{.metadata}}&payment_intent_data={{.paymentIntentData}}&payment_method_collection={{.paymentMethodCollection}}&payment_method_types={{.paymentMethodTypes}}&phone_number_collection={{.phoneNumberCollection}}&shipping_address_collection={{.shippingAddressCollection}}&shipping_options={{.shippingOptions}}&submit_type={{.submitType}}&subscription_data={{.subscriptionData}}&tax_id_collection={{.taxIdCollection}}",
          "placeholders": [
            {
              "name": "apiKey",
              "type": "String",
              "description": "Stripe API key for authentication.",
              "required": true
            },
            {
              "name": "lineItems",
              "type": "Array",
              "description": "Array of line items for the payment link.",
              "required": true
            },
            {
              "name": "afterCompletion",
              "type": "Object",
              "description": "Behavior after payment completion.",
              "required": false
            },
            {
              "name": "automaticTax",
              "type": "Object",
              "description": "Automatic tax configuration.",
              "required": false
            },
            {
              "name": "billingAddressCollection",
              "type": "String",
              "description": "Billing address collection mode.",
              "required": false
            },
            {
              "name": "consentCollection",
              "type": "Object",
              "description": "Consent collection configuration.",
              "required": false
            },
            {
              "name": "customText",
              "type": "Object",
              "description": "Custom text for the payment link.",
              "required": false
            },
            {
              "name": "customerCreation",
              "type": "String",
              "description": "Customer creation mode.",
              "required": false
            },
            {
              "name": "invoiceCreation",
              "type": "Object",
              "description": "Invoice creation configuration.",
              "required": false
            },
            {
              "name": "metadata",
              "type": "Object",
              "description": "Metadata for the payment link.",
              "required": false
            },
            {
              "name": "paymentIntentData",
              "type": "Object",
              "description": "Payment intent data.",
              "required": false
            },
            {
              "name": "paymentMethodCollection",
              "type": "String",
              "description": "Payment method collection mode.",
              "required": false
            },
            {
              "name": "paymentMethodTypes",
              "type": "Array",
              "description": "Array of payment method types.",
              "required": false
            },
            {
              "name": "phoneNumberCollection",
              "type": "Object",
              "description": "Phone number collection configuration.",
              "required": false
            },
            {
              "name": "shippingAddressCollection",
              "type": "Object",
              "description": "Shipping address collection configuration.",
              "required": false
            },
            {
              "name": "shippingOptions",
              "type": "Array",
              "description": "Array of shipping options.",
              "required": false
            },
            {
              "name": "submitType",
              "type": "String",
              "description": "Submit type for the payment link.",
              "required": false
            },
            {
              "name": "subscriptionData",
              "type": "Object",
              "description": "Subscription data.",
              "required": false
            },
            {
              "name": "taxIdCollection",
              "type": "Object",
              "description": "Tax ID collection configuration.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}