Action: Create a Subscription

Stripe Operation

Create a new subscription in Stripe

Example User Story

As a business I wish to create a new subscription for a customer in Stripe, so that we may receive a recurring payment from the customer.

Fields

Field Name	Field Type	Required
customer	String	Yes
items	Array	Yes
default_payment_method	String	No
coupon	String	No
trial_period_days	Integer	No

Related Connections

Stripe

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-subscription",
  "state": "inDev",
  "meta": {
    "short": "Create Subscription",
    "description": "Creates a new subscription for a customer in Stripe."
  },
  "input": [
    {
      "name": "customer",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The identifier of the customer to subscribe."
      }
    },
    {
      "name": "items",
      "type": "Array",
      "required": true,
      "meta": {
        "description": "A list of items, each with a plan or price ID and quantity."
      }
    },
    {
      "name": "default_payment_method",
      "type": "String",
      "required": false,
      "meta": {
        "description": "ID of the payment method to attach to this subscription."
      }
    },
    {
      "name": "coupon",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The code of the coupon to apply to this subscription."
      }
    },
    {
      "name": "trial_period_days",
      "type": "Integer",
      "required": false,
      "meta": {
        "description": "Number of trial period days granted when subscribing the customer."
      }
    }
  ],
  "output": [
    {
      "name": "subscriptionId",
      "type": "String",
      "selector": ["id"],
      "meta": {
        "description": "The unique identifier for the subscription."
      }
    },
    {
      "name": "status",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "The status of the subscription."
      }
    },
    {
      "name": "currentPeriodEnd",
      "type": "Integer",
      "selector": ["current_period_end"],
      "meta": {
        "description": "The end of the current period that the subscription has been invoiced for."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/v1/subscriptions",
        "headers": {
          "Content-Type": "application/x-www-form-urlencoded"
        },
        "bodyTemplate": {
          "value": "customer={{customer}}&items={{items}}&default_payment_method={{default_payment_method}}&coupon={{coupon}}&trial_period_days={{trial_period_days}}",
          "placeholders": [
            {
              "name": "customer",
              "type": "String",
              "description": "The identifier of the customer to subscribe.",
              "required": true
            },
            {
              "name": "items",
              "type": "Array",
              "description": "A list of items, each with a plan or price ID and quantity.",
              "required": true
            },
            {
              "name": "default_payment_method",
              "type": "String",
              "description": "ID of the payment method to attach to this subscription.",
              "required": false
            },
            {
              "name": "coupon",
              "type": "String",
              "description": "The code of the coupon to apply to this subscription.",
              "required": false
            },
            {
              "name": "trial_period_days",
              "type": "Integer",
              "description": "Number of trial period days granted when subscribing the customer.",
              "required": false
            }
          ]
        }
      }
    }
  ]
}