Connectors Reference
Stripe allows private individuals and businesses to accept payments over the internet. You can track customers, orders, invoices and more.
|
Status: Production |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Update a product |
|
|
Create a product |
|
|
Get a customer |
|
|
UpdateCustomer (string id, [Optional]UpdateCustomerParameterBody body) |
Update a customer |
|
Create a customer |
|
Name |
Summary |
|
When a customer is added |
|
|
When an order is added |
|
|
When a charge is added |
|
|
When an invoice item is added |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
Discount |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 |
|
|
True |
Returns:
Type:Product_Response
Summary: Create a product
Description: Creates a new product.
Syntax:
Stripe.CreateProduct (CreateProductParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:Product_Response
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
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 |
|
|
False |
Returns:
Type:Customer_Response
Summary: Create a customer
Description: Create a new customer.
Syntax:
Stripe.CreateCustomer ([Optional]CreateCustomerParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Type:Customer_Response
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
Summary: When an order is added
Description: Triggers a new flow when an order is added.
Syntax:
Stripe.OnNewOrder ()
Returns:
Type:array of (OnNewOrderResponseItem)
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
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
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Unique identifier for the object. |
|
name |
string Name |
Name of the coupon displayed to customers on for instance invoices or receipts. |
|
duration |
string Duration |
One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount. |
|
percent_off |
number(float) Percent off |
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. |
|
amount_off |
number(float) Amount off |
Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. |
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. |
|
|
string |
The email address of the customer, this will be unset if you send with an empty value. |
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. |
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 |
Discount |
Describes the current discount active on the customer, if there is one. |
|
|
string |
The email of the customer. |
Summary: Discount
Description: Describes the current discount active on the customer, if there is one.
Properties:
|
Name |
Type |
Summary |
|
customer |
string Customer |
The ID of the customer associated with this discount. |
|
end |
integer(int32) End |
If the coupon has a duration of repeating, the date that this discount will end. |
|
start |
integer(int32) Start |
Date that the coupon was applied. |
|
subscription |
string Subscription |
The subscription that this coupon is applied to, if it is applied to a particular subscription. |
|
coupon |
|
|
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. |
|
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 |
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. |
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. |
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 |
Discount |
Describes the current discount active on the customer, if there is one. |
|
|
string |
The email of the customer. |
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 |
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 |
integer(int32) 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. |
Summary: Plan
Description: If the invoice item is a proration, the plan of the subscription that the proration was computed for.
Properties:
|
Name |
Type |
Summary |
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. |
|
|
string |
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. |
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. |
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. |
|
|
string |
The email address of the customer, this will be unset if you send with an empty value. |
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. |