Action: Create an Invoice

Stripe Operation

The Create an Invoice action enables users to create an invoice in Stripe.

Example User Story

I want to create an invoice in Stripe in order to invoice a customer for their order.

Fields

Field Name	Field Type	Required
customer	String	Yes
amount	Integer	Yes
currency	String	No
description	String	No
apiKey	String	Yes

Related Connections

Stripe

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-invoice",
  "state": "inDev",
  "meta": {
    "short": "Create Invoice",
    "description": "Creates an invoice in Stripe."
  },
  "input": [
    {
      "name": "customer",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the customer to invoice."
      }
    },
    {
      "name": "amount",
      "type": "Integer",
      "required": true,
      "meta": {
        "description": "The amount to invoice, in the smallest currency unit."
      }
    },
    {
      "name": "currency",
      "type": "String",
      "required": false,
      "meta": {
        "description": "Three-letter ISO currency code.",
        "default": "usd"
      }
    },
    {
      "name": "description",
      "type": "String",
      "required": false,
      "meta": {
        "description": "An arbitrary string attached to the invoice."
      }
    }
  ],
  "output": [
    {
      "name": "invoiceId",
      "type": "String",
      "selector": ["id"],
      "meta": {
        "description": "The ID of the created invoice."
      }
    },
    {
      "name": "invoiceStatus",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "The status of the created invoice."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v1/invoices",
        "headers": {
          "Content-Type": "application/x-www-form-urlencoded"
        },
        "bodyTemplate": {
          "value": "customer={{.customer}}&amount={{.amount}}&currency={{.currency}}&description={{.description}}",
          "placeholders": [
            {
              "name": "apiKey",
              "type": "String",
              "description": "Stripe API key.",
              "required": true
            },
            {
              "name": "customer",
              "type": "String",
              "description": "The ID of the customer to invoice.",
              "required": true
            },
            {
              "name": "amount",
              "type": "Integer",
              "description": "The amount to invoice, in the smallest currency unit.",
              "required": true
            },
            {
              "name": "currency",
              "type": "String",
              "description": "Three-letter ISO currency code.",
              "required": false,
              "default": "usd"
            },
            {
              "name": "description",
              "type": "String",
              "description": "An arbitrary string attached to the invoice.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}