Stripe

Overview

Events

• New Charge

  This event card triggers a Flow when a new charge is made in Stripe.

  Fields

  • Charge
    • Charge ID (text): The ID of the charge.
    • Amount (number): The amount of the charge.
    • Amount Refunded(number): The amount refunded.
    • Application(text): The ID of the Connect application that created the charge.
    • Application Fee(text): The application fee (if any) for the charge.
    • Balance Transaction(text): The ID of the balance transaction that describes the impact of the charge on your account balance (does not include refunds or disputes).
    • Captured(T/F): If the charge was created without capturing.
    • Created Time (unix)(number): The time the charge was created. Measured in seconds since the Unix epoch.
    • Currency(text): The ISO currency code i.e. “USD”.
    • Customer ID(text): The ID of the customer.
    • Description(text): A description of the charge.
    • Destination(text): The account (if any) the charge was made on behalf of, with an automatic transfer.
    • Dispute(text): Details about the dispute if the charge has been disputed.
    • Failure Code(text): Error code explaining reason for charge failure if available.
    • Failure Message(text): Message to the user further explaining reasoning for a charge failure.
    • Fraud Details(object): Hash with information on fraud assessments for the charge.
    • Invoice ID(text): The ID of the invoice this charge is for if one exists.
    • On Behalf Of(text): The account (if any) the charge was made on behalf of without triggering an automatic transfer.
    • Order(text): ID of the order this charge is for if one exists.
    • Paid(T/F): If the charge was paid or not.
    • Receipt Email(text): The email address the receipt for the charge was sent to.
    • Receipt Number(text): The receipt number.
    • Refunded(T/F): If the charge was refunded
    • Review(text): The ID of the
    • Shipping(text): Shipping information for the charge.
    • Source Transfer(text): The transfer ID which created the charge. Only present if the charge came from another Stripe account.
    • Statement Descriptor(text): Extra information about the charge.
    • Status(text): The status of the payment. Either ‘succeeded’, ‘pending’, or ‘failed’.
    • Transfer Group(text): A string that identifies this transaction as part of a group.
    • Metadata(object): Metadata for the charge.
  • Outcome
    • Network Status(text): Possible values are ‘approved_by_network’, ‘declined_by_network’, ‘not_sent_to_network’, and ‘reversed_after_approval’. The ‘value reversed_after_approval’ indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as “pending” on a cardholder’s statement.
    • Reason(text): An enumerated value indicating a more detailed explanation of the outcome’s type.
    • Risk Level(number): Stripe’s evaluation of the riskiness of the payment. Possible values for evaluated payments are ‘normal’, ‘elevated’, ‘highest’. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value not_assessed. In the event of an error in the evaluation, this field will have the value unknown.
    • Seller Message(number): A readable description of the outcome type and reason, designed for the recipient.
    • Type(text): Possible values are ‘authorized’, ‘manual_review’, ‘issuer_declined’, ‘blocked’, and ‘invalid’.
  • Refunds
    • Data (object): The refund (if available).
    • URL(text): The URL of the refund.
  • Source
    • Source ID(text): The ID of the bank account object.
    • Object(text): String representing the object’s type.
    • Address City(text): city/district/suburb/town/village.
    • Address Country(text): Billing address country.
    • Address Line 1(text): Address line 1.
    • Address Line 1 Check(text): Results of a check; ‘pass’, ‘fail’, ‘unavailable’, or ‘unchecked’.
    • Address Line 2(text): Address line 2.
    • Address State(text): State/county/province/region.
    • Address Zip(text): Zip/postal code.
    • Address Zip Check(text): The results of a check; ‘pass’, ‘fail’, ‘unavailable’, or ‘unchecked’.
    • Brand(text): The brand of the card used; Visa, American Express, MasterCard, etc.
    • Country(text): The two letter ISO code representing the country of the card.
    • Customer ID(text): The ID of the customer the card belongs to.
    • Cvc Check(text): If a CVC was provided, results of the check: ‘pass’, ‘fail’, ‘unavailable’, or ‘unchecked’.
    • Dynamic Last 4(text): Last 4 digits of a customer’s card.
    • Exp Month(number): The card’s expiration month.
    • Exp Year(number): The card’s expiration year.
    • Fingerprint(text): Uniquely identifies the particular bank account. You can use this to check whether two bank accounts are the same.
    • Funding(text): The type of card; ‘credit’, ‘debit’, ‘prepaid’, or ‘unknown’.
    • Last 4(text): The last 4 digits of the card.
    • Name(text): Cardholder name.
    • Tokenization Method(text): If the card number is tokenized, this is the method that was used. Can be ‘apple_pay’, or ‘android_pay’.
  • Context
    • Execution ID(text): The ID of the event.

• New Customer

  Triggers a Flow when a new customer is created in Stripe.

  Fields

  • Author
    • Customer ID (text): The ID of the new customer.
  • Message
    • Customer Email(text): The customer’s email address.
    • Shipping Address Line 1(text): The first line of the customer’s shipping address.
    • Shipping Address Line 2(text): The second line of the customer’s shipping address.
    • Shipping City_(text):  _The customer’s shipping address city.
    • Shipping State(text): The customer’s shipping address state.
    • Shipping Country(text): The customer’s shipping address country.
    • Shipping Postal Code(text): The customer’s shipping address Zip/Postal code.
    • Phone Number(text): The customer’s phone number.
    • Currency (text): The ISO currency code for the customer.
    • Time Created (unix) (text): The time the customer was created. Measured in seconds since the Unix epoch.
  • Context
    • Execution ID(text): The ID of the event.

• New Subscription

  Triggers a Flow when a new subscription is made in Stripe.

  Inputs

  • Subscription
    • Subscription ID (text): The ID of the subscription.
    • Customer ID(text): The ID of the customer who made the subscription.
    • Time Created (unix) (number): The time created, meaured in seconds since unix epoch.
    • Current Period Starts (unix)(number): When the current subscription period started; measured in seconds since unix epoch.
    • Current Period Ends (unix)(number): When the current subscription period ends.
    • Ended At (unix)(number): When (if) the subscription ended.
    • Canceled At (unix)(number): When (if) the subscription was canceled.
    • Cancel at Period End(T/F): If the subscription will be canceled at the end of the period.
    • Application Fee Percent(text): A non-negative decimal (with at most two decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account.
    • Quantity(number): The quantity of the plan to which the customer should be subscribed.
    • Start (unix)(number): Date the most recent update to this subscription started.
    • Status(text): The status of the subscription. ‘trialing’, ‘active’, ‘past_due’, ‘canceled’, or ‘unpaid.
    • Tax Percent(number): If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.
    • Trial Start (unix)(number): If the subscription has a trial, the beginning of that trial.
    • Trial End (unix)(number): If the subscription has a trial, the end of that trial.
    • Metadata(object):
  • Plan
    • ID(text): The plan ID.
    • Name(text): The name of the plan.
    • Amount(number): The amount (in cents) to be charged on the interval specified.
    • Time Created (unix)(number): The time the plan was created measured in seconds since unix epoch.
    • Currency(text): The ISO currency code.
    • Interval(text): ‘day’, ‘week’, ‘month’, or ‘year’
    • Interval Count (number): The number of intervals between each subscription billing.
    • Statement Descriptor(text): Extra information about a charge for the customer’s credit card statement.
    • Trial Period Days(text): Number of trial period days granted when subscribing a customer to this plan.
  • Discount
    • Coupon ID(text): The ID of the coupon.
    • Amount Off(text): The amount that will be taken off.
    • Currency(text): If amount off is assigned a value, the ISO code for it.
    • Duration(text): ‘forever’, ‘once’, or ‘repeating’. How long a customer who applies this coupon will get the discount for.
    • Duration in Months(text): If the duration is repeating, it is the number of months the coupon applies.
    • Max Redemptions(text): The maximum number of times the coupon can be redeemed.
    • Percent Off(number): The percent that will be taken off.
    • Redeem By(text): The date after which the coupon can no longer be redeemed.
    • Start Time (unix)(number): The date the coupon becomes valid.
    • Times Redeemed(number): The number of times the coupon has been redeemed.
    • Valid(T/F): If the coupon is valid.
  • Context
    • Execution ID(text): The ID of the event.

• Updated Subscription

  Triggers a Flow when a subscription is updated in Stripe.

  Inputs

  • Subscription
    • Subscription ID (text): The ID of the subscription.
    • Customer ID(text): The ID of the customer who made the subscription.
    • Time Created (unix) (number): The time created, meaured in seconds since unix epoch.
    • Current Period Starts (unix)(number): When the current subscription period started; measured in seconds since unix epoch.
    • Current Period Ends (unix)(number): When the current subscription period ends.
    • Ended At (unix)(number): When (if) the subscription ended.
    • Canceled At (unix)(number): When (if) the subscription was canceled.
    • Cancel at Period End(T/F): If the subscription will be canceled at the end of the period.
    • Application Fee Percent(text): A non-negative decimal (with at most two decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account.
    • Quantity(number): The quantity of the plan to which the customer should be subscribed.
    • Start (unix)(number): Date the most recent update to this subscription started.
    • Status(text): The status of the subscription. ‘trialing’, ‘active’, ‘past_due’, ‘canceled’, or ‘unpaid.
    • Tax Percent(number): If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.
    • Trial Start (unix)(number): If the subscription has a trial, the beginning of that trial.
    • Trial End (unix)(number): If the subscription has a trial, the end of that trial.
    • Metadata(object):
  • Plan
    • ID(text): The plan ID.
    • Name(text): The name of the plan.
    • Amount(number): The amount (in cents) to be charged on the interval specified.
    • Time Created (unix)(number): The time the plan was created measured in seconds since unix epoch.
    • Currency(text): The ISO currency code.
    • Interval(text): ‘day’, ‘week’, ‘month’, or ‘year’
    • Interval Count (number): The number of intervals between each subscription billing.
    • Statement Descriptor(text): Extra information about a charge for the customer’s credit card statement.
    • Trial Period Days(text): Number of trial period days granted when subscribing a customer to this plan.
  • Discount
    • Coupon ID(text): The ID of the coupon.
    • Amount Off(text): The amount that will be taken off.
    • Currency(text): If amount off is assigned a value, the ISO code for it.
    • Duration(text): ‘forever’, ‘once’, or ‘repeating’. How long a customer who applies this coupon will get the discount for.
    • Duration in Months(text): If the duration is repeating, it is the number of months the coupon applies.
    • Max Redemptions(text): The maximum number of times the coupon can be redeemed.
    • Percent Off(number): The percent that will be taken off.
    • Redeem By(text): The date after which the coupon can no longer be redeemed.
    • Start Time (unix)(number): The date the coupon becomes valid.
    • Times Redeemed(number): The number of times the coupon has been redeemed.
    • Valid(T/F): If the coupon is valid.
  • Context
    • Execution ID(text): The ID of the event.

Actions

• Cancel Subscription

  Cancels a subscription in Stripe.

  Options

  • Cancel at Period End (T/F): If true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. By default, the subscription is terminated immediately.

  Inputs

  • CustomerId (text): The ID of the customer whose subscription will end. The customer ID is in the URL of the customer (https://dashboard.stripe.com/customers/**cus_B1E0R7NEOqCj7x**) and also the ‘details’ section of the customer on Stripe. Customer ID is also provided when a new customer is created using ‘Create Customer’.
  • SubscriptionId (text): The ID of the subscription to be ended. The subscription ID can be found in the URL (https://dashboard.stripe.com/subscriptions/**sub_B1EsfBE33CUZZU**) and also in the ‘details’ section of the subscription on Stripe.

  Outputs

  • There are no output fields for this card.

• Create Customer

  Creates a new customer in Stripe.

  Input Fields

  • Customer
    • CustomerEmail (text): The email of the new customer.
    • CustomerPhone (text): The phone number of the new customer.
    • CustomerDescription (text): A description of the customer.
    • PlanId (text): Plans are the heart of subscriptions in that they manage the billing cycle. currency, and base cost. The ID can be found in the URL of the plan (https://dashboard.stripe.com/plans/**123345**), under plan details in Stripe, or by using ‘Read Subscription’.
    • PlanQuantity (text): The number of plans the customer has.
    • SourceId (text): Customer payment source
    • TaxPercent (text): Tax percentage.
    • TrialEndDate (text): The end date of their subscription.
  • Address
    • ShippingName (text): The name of the address.
    • ShippingAddressLine1 (text): Street address
    • ShippingAddressLine2 (text): Unit number
    • ShippingCity (text): City
    • ShippingState (text): State
    • ShippingCountry (text): Country
    • ShippingPostalCode (text): Zip/Postal Code

  Output Fields

  • Customer
    • CustomerId (text): The identifier for the new customer.

• Create Plan

  Creates a plan in Stripe.

  Inputs

  • Plan
    • Name (text): The name of the plan.
    • Amount (text): The amount (money) for the plan.
    • Interval (text): The billing interval; month, day, week, or year.
    • Currency (text): ISO code   ie: “USD”.
    • PlanId (text): Create a unique identifier that will be used to keep track of the plan. Can be a mix of letters and numbers.

  Outputs

  • Plan
    • PlanId (text): The identifier for the plan, created above.

• Create Subscription

  Creates a subscription in Stripe.

  Inputs

  • Subscription
    • CustomerID (text): The ID of the customer. Given if you use the ‘Create Customer’ card, but can also be found in the URL of the customer, or in the details section for the customer on Stripe.
    • PlanID (text): The identifier for the plan. The ID can be found in the URL of the plan (https://dashboard.stripe.com/plans/**123345**), under plan details in Stripe, or by using ‘Read Subscription’ if a subscription with that plan already exists.
    • SourceId (text): The customer payment information.
    • CouponCode (text): A coupon.
    • Quantity (text): How many subscriptions.
    • TaxPercent(text): Tax percent.
    • TrialEndDate(text): The date the subscription ends.

  Outputs

  • Subscription
    • SubscriptionId (text): The identifier for the subscription, created above.

• Delete Customer

  Deletes a customer in Stripe.

  Inputs

  • Customer
    • CustomerId (text): The ID of the customer you wish to delete. Customer ID can be found in the URL of the customer (https://dashboard.stripe.com/customers/**cus_B1E0R7NEOqCj7x**) or in the ‘details’ section of the customer on Stripe.

  Outputs

  • There are no output fields for this card.

• Read All Plans

• Read Coupon

  Gets information for a coupon in Stripe.

  Inputs

  • Coupon
    • CouponId (text): The ID of the coupon. Coupon ID can be found in the URL of the coupon (https://dashboard.stripe.com/coupons/**776766**) or in the ‘details’ section of the coupon in Stripe.

  Outputs

  • Coupon
    • Percent Off (text): The percentage off the coupon gives.
    • Amount Off (text): alternative to percentage off; the set amount off the coupon gives.
    • Currency (text): ISO code; ie “USD”.
    • Time Created (text): What time/date the coupon was created.
    • Duration (text): How long the coupon will last once applied by the customer. Once, multi-month, or forever.
    • Duration Months (text): If duration is months.
    • Number of Redemptions (text): How many times it has been redeemed.
    • Maximum Redemptions (text): How many times it is allowed to be redeemed.
    • Redeem By Date (text): When the coupon must be redeemed by.
    • Valid (text): true or false.

• Read Customer

  Gets information for a customer in Stripe.

  Inputs

  • Customer
    • CustomerId (text): The ID of the customer. Customer ID can be found in the URL of the customer (https://dashboard.stripe.com/customers/**776766**) or in the ‘details’ section of the customer in Stripe.

  Outputs

  • Customer
    • CustomerEmail (text): The email of the customer.
    • CustomerPhone (text): The phone number of the customer.
    • CustomerDescription (text): A description of the customer.
    • SourceId (text): Customer payment source
    • TaxPercent (text): Tax percentage.
    • TrialEndDate (text): The end date of their subscription.
  • Plan
    • ID (text): Plans are the heart of subscriptions in that they manage the billing cycle. currency, and base cost. The ID can be found in the URL of the plan (https://dashboard.stripe.com/plans/**123345**), under plan details in Stripe, or by using ‘Read Subscription’.
    • Amount (text): The number of plans the customer has.
    • Currency (text): The ISO currency code, ie “USD”
    • Interval (text): How often the plan is renewed.
  • Address
    • ShippingName (text): The name of the address.
    • ShippingAddressLine1 (text): Street address
    • ShippingAddressLine2 (text): Unit number
    • ShippingCity (text): City
    • ShippingState (text): State
    • ShippingCountry (text): Country
    • ShippingPostalCode (text): Zip/Postal Code

• Read Customer Subscriptions

  Read all subscriptions associated with a customer

• Read Subscription

  Gets information on a subscription in Stripe.

  Inputs

  • Subscription
    • CustomerID (text): The ID of the customer. Given if you use the ‘Create Customer’ card, but can also be found in the URL of the customer, or in the details section for the customer on Stripe.
    • SubscriptionId (text): The identifier for the subscription. Can be found in the URL of the subscription, or in the ‘details’ section of the subscription.

  Outputs

  • Subscription
    • SubscriptionId (text): The identifier for the subscription, created above.
    • Start Date (text): The start date of the subscription.
    • Cancel Date (text): The date the subscription was cancelled.
    • End Date (text): The end of the subscription.
    • Trial Start Date (text): The trial start.
    • Trial End Date (text): The date the subscription trial ends.
    • Cancel at Period End (text): if the subscription will be cancelled at the end of the period or if it will be renewed.
    • Current Period Start (text): When the current period started.
    • Discount Code (text): A discount code.
    • Status (text): trialing, active, past_due, canceled, or unpaid.
    • Tax Percent (text): Tax percent.
  • Plan
    • PlanID (text): The identifier for the plan. The ID can also be found in the URL of the plan (https://dashboard.stripe.com/plans/**123345**), under plan details in Stripe.
    • Plan Name (text): The name of the plan
    • Plan Quantity (text): Quantity of the plan.

• Search Cu

• Search Customers

• Search Subscriptions

• Update Customer

  Updates an existing customer in Stripe.

  Input Fields

  • Update By
    • CustomerId (text): The identifier for the customer. Can be found in the URL of the customer or in the ‘details’ section of the customer in Stripe.
  • Customer
    • AccountBalance(text):
    • Coupon(text):
    • CustomerEmail (text): The email of the customer.
    • CustomerPhone (text): The phone number of the customer.
    • CustomerDescription (text): A description of the customer.
    • SourceId (text): Customer payment source
    • TaxPercent (text): Tax percentage.
    • TrialEndDate (text): The end date of their subscription.
  • Address
    • ShippingName (text): The name of the address.
    • ShippingAddressLine1 (text): Street address
    • ShippingAddressLine2 (text): Unit number
    • ShippingCity (text): City
    • ShippingState (text): State
    • ShippingCountry (text): Country
    • ShippingPostalCode (text): Zip/Postal Code

  Output Fields

  • There are no output fields for this card.

• Update Subscription

  Updates an existing subscription in Stripe.

  Inputs

  • Update By
    • Customer Id (text): The ID of the customer. Given if you use the ‘Create Customer’ card, but can also be found in the URL of the customer, or in the details section for the customer on Stripe.
    • SubscriptionId (text): The identifier for the subscription. Found in the URL of the subscription or in the ‘details’ section of the subscription in Stripe.
  • Subscription
    • PlanID (text): The identifier for the plan. The ID can be found in the URL of the plan (https://dashboard.stripe.com/plans/**123345**), under plan details in Stripe, or by using ‘Read Subscription’ if a subscription with that plan already exists.
    • Quantity (text): How many subscriptions.
    • TaxPercent(text): Tax percent.
    • TrialEndDate(text): The date the subscription ends.

  Outputs

  • There are no output fields for this card.