Connectors Reference

Stripe

Stripe allows private individuals and businesses to accept payments over the internet. You can track customers, orders, invoices and more.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

UpdateProduct (string id, UpdateProductParameterBody body)

Update a product

CreateProduct (CreateProductParameterBody body)

Create a product

GetCustomer (string id)

Get a customer

UpdateCustomer (string id, [Optional]UpdateCustomerParameterBody body)

Update a customer

CreateCustomer ([Optional]CreateCustomerParameterBody body)

Create a customer

 

Triggers:

Name

Summary

OnNewCustomer ()

When a customer is added

OnNewOrder ()

When an order is added

OnNewCharge ()

When a charge is added

OnNewInvoiceItem ()

When an invoice item is added

 

Objects:

Name

Summary

CreateCustomerParameterBody

 

CreateProductParameterBody

 

Customer_Response

 

OnNewChargeResponseItem

 

OnNewCustomerResponseItem

 

OnNewInvoiceItemResponseItem

 

OnNewOrderResponseItem

 

Product_Response

 

UpdateCustomerParameterBody

 

UpdateProductParameterBody

 

 

Actions:

UpdateProduct

Summary: Update a product

Description: Updates the specific product by setting the values of the parameters passed.

 

Syntax:

Stripe.UpdateProduct (string id, UpdateProductParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id)

The identifier for the product.

True

body

UpdateProductParameterBody

 

 

True

 

Returns:

††††††††† Type:Product_Response

 

CreateProduct

Summary: Create a product

Description: Creates a new product.

 

Syntax:

Stripe.CreateProduct (CreateProductParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateProductParameterBody

 

 

True

 

Returns:

††††††††† Type:Product_Response

 

GetCustomer

Summary: Get a customer

Description: Returns the details of specified customer.

 

Syntax:

Stripe.GetCustomer (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id)

The id of the customer.

True

 

Returns:

††††††††† Type:Customer_Response

 

UpdateCustomer

Summary: Update a customer

Description: Updates the specified customer by setting the values of the parameters passed.

 

Syntax:

Stripe.UpdateCustomer (string id, [Optional]UpdateCustomerParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id)

The id of the customer.

True

body

UpdateCustomerParameterBody

 

 

False

 

Returns:

††††††††† Type:Customer_Response

 

CreateCustomer

Summary: Create a customer

Description: Create a new customer.

 

Syntax:

Stripe.CreateCustomer ([Optional]CreateCustomerParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateCustomerParameterBody

 

 

False

 

Returns:

††††††††† Type:Customer_Response

 

Triggers:

Trigger OnNewCustomer

Summary: When a customer is added

Description: Triggers a new flow when a customer is added.

 

Syntax:

Stripe.OnNewCustomer ()

 

Returns:

††††††††† Type:array of (OnNewCustomerResponseItem)

††††††††† Description: data

 

Trigger OnNewOrder

Summary: When an order is added

Description: Triggers a new flow when an order is added.

 

Syntax:

Stripe.OnNewOrder ()

 

Returns:

††††††††† Type:array of (OnNewOrderResponseItem)

 

Trigger OnNewCharge

Summary: When a charge is added

Description: Triggers a new flow when a charge is added.

 

Syntax:

Stripe.OnNewCharge ()

 

Returns:

††††††††† Type:array of (OnNewChargeResponseItem)

††††††††† Description: data

 

Trigger OnNewInvoiceItem

Summary: When an invoice item is added

Description: Triggers a new flow when an invoice item is added.

 

Syntax:

Stripe.OnNewInvoiceItem ()

 

Returns:

††††††††† Type:array of (OnNewInvoiceItemResponseItem)

††††††††† Description: data

 


 

CreateCustomerParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

description

string

Description

An arbitrary string that you can attach to a customer, this will be unset if you send with an empty value.

email

string

Email

The email address of the customer, this will be unset if you send with an empty value.


 

CreateProductParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

Name

The productís name, meant to be displayable to the customer.

id

string

Id

The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.

active

boolean

Active

Whether or not the product is currently available for purchase. Defaults to true.

caption

string

Caption

A short one-line description of the product, meant to be displayable to the customer.

description

string

Description

The productís description, meant to be displayable to the customer.

images

string

Images

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

shippable

boolean

Shippable

Whether this product is shipped (i.e. physical goods). Defaults to true.

url

string

URL

A URL of a publicly-accessible webpage for this product.


 

Customer_Response

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

The id of the customer.

account_balance

integer(int32)

Account Balance

Current balance, if any, being stored on the customerís account.

created

string(date-time)

Created

The datetime the customer was created.

currency

string

Currency

The currency the customer can be charged in for recurring billing purposes.

delinquent

boolean

Delinquent

Whether or not the latest charge for the customerís latest invoice has failed.

description

string

Description

The description of the customer.

discount

string

Discount

Describes the current discount active on the customer, if there is one.

email

string

Email

The email of the customer.


 

OnNewChargeResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

The id of the charge.

amount

integer(int32)

Amount

A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge •100, a 0-decimal currency) representing how much to charge.

amount_refunded

integer(int32)

Amount Refunded

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

captured

boolean

Captured

If the charge was created without capturing, this boolean represents whether or not it is still uncaptured or has since been captured.

created

string(date-time)

Created

The datetime the charge was created.

currency

string

Currency

Three-letter ISO currency code representing the currency in which the charge was made.rrency

customer

string

Customer

ID of the customer this charge is for if one exists.

description

string

Description

The description of the charge.

failure_code

string

Failure Code

Error code explaining reason for charge failure if available.

failure_message

string

Failure Message

Message to user further explaining reason for charge failure if available.

invoice

string

Invoice

ID of the invoice this charge is for if one exists.

order

string

Order

ID of the order this charge is for if one exists.

outcome

Outcome

Outcome

Details about whether or not the payment was accepted, and why.

paid

boolean

Paid

True if the charge succeeded, or was successfully authorized for later capture.

receipt_email

string

Receipt Email

This is the email address that the receipt for this charge was sent to.

receipt_number

string

Receipt Number

This is the transaction number that appears on email receipts sent for this charge.

refunded

boolean

Refunded

Whether or not the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

statement_descriptor

string

Statement Descriptor

Extra information about a charge. This will appear on your customerís credit card statement.

status

string

Status

The status of the payment is either succeeded, pending, or failed.

 

Outcome

Summary: Outcome

Description: Details about whether or not the payment was accepted, and why.

 

††††††††† Properties:

Name

Type

Summary

network_status

string

Network Status

Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval.

reason

string

Reason

An enumerated value indicating a more detailed explanation of the outcomeís type.

risk_level

string

Risk Level

Stripeís evaluation of the riskiness of the payment.

seller_message

string

Seller Message

A human-readable description of the outcome type and reason, designed for the recipient of the payment.

type

string

Type

Possible values are authorized, issuer_declined, blocked, and invalid.

 


 

OnNewCustomerResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

The id of the customer.

account_balance

integer(int32)

Account Balance

Current balance, if any, being stored on the customerís account.

created

string(date-time)

Created

The datetime the customer was created.

currency

string

Currency

The currency the customer can be charged in for recurring billing purposes.

delinquent

boolean

Delinquent

Whether or not the latest charge for the customerís latest invoice has failed.

description

string

Description

The description of the customer.

discount

string

Discount

Describes the current discount active on the customer, if there is one.

email

string

Email

The email of the customer.


 

OnNewInvoiceItemResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

The id of the invoice item.

amount

integer(int32)

Amount

A positive integer in the smallest currency unit representing the total amount for the invoice item.

currency

string

Currency

3-letter ISO code representing the currency in which the invoice item was made.

customer

string

Customer

The customer id used for the invoice item.

date

string(date-time)

Date

The date of the invoice item.

description

string

description

The description of the invoice item.

discountable

boolean

Discountable

If true, discounts will apply to this invoice item. Always false for prorations.

invoice

string

Invoice

The id of the invoice the invoice item was added to.

plan

string

Plan

If the invoice item is a proration, the plan of the subscription that the proration was computed for.

proration

boolean

Proration

Whether or not the invoice item was created automatically as a proration adjustment when the customer switched plans.

quantity

string

Quantity

If the invoice item is a proration, the quantity of the subscription that the proration was computed for.

subscription

string

Subscription

The subscription that this invoice item has been created for, if any.


 

OnNewOrderResponseItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

The id of the order.

amount

integer(int32)

Amount

A positive integer in the smallest currency unit.

amount_returned

integer

Amount Returned

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

charge

string

Charge

The ID of the payment used to pay for the order. Present if the order status is paid, fulfilled, or refunded.

created

string(date-time)

Created

The datetime the order was created.

currency

string

Currency

3-letter ISO code representing the currency in which the order was made.

customer

string

Customer

The customer used for the order.

email

string

Email

The email address of the customer placing the order.

selected_shipping_method

string

Selected Shipping method

The shipping method that is currently selected for this order, if any.

status

string

Status

Current order status. One of created, paid, canceled, fulfilled, or returned.

updated

string(date-time)

Updated

The datetime the order was updated.


 

Product_Response

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

The id of the product.

active

boolean

Active

Whether or not the product is currently available for purchase.

caption

string

Caption

A short one-line description of the product, meant to be displayable to the customer.

created

string(date-time)

Created

the datetime the product was created at.

description

string

Description

The productís description, meant to be displayable to the customer.

images

array of (string)

Images

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

name

string

Name

The productís name, meant to be displayable to the customer.

shippable

boolean

Shippable

Whether this product is a shipped good.

updated

string(date-time)

Updated

The datetime the product was updated.

url

string

URL

A URL of a publicly-accessible webpage for this product.


 

UpdateCustomerParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

description

string

Description

An arbitrary string that you can attach to a customer, this will be unset if you send with an empty value.

email

string

Email

The email address of the customer, this will be unset if you send with an empty value.


 

UpdateProductParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

Name

The productís name, meant to be displayable to the customer.

active

boolean

Active

Whether or not the product is currently available for purchase. Defaults to true.

caption

string

Caption

A short one-line description of the product, meant to be displayable to the customer.

description

string

Description

The productís description, meant to be displayable to the customer.

images

string

Images

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

shippable

boolean

Shippable

Whether this product is shipped (i.e. physical goods). Defaults to true.

url

string

URL

A URL of a publicly-accessible webpage for this product.