ByteChef LogoByteChef
Components

Stripe

Stripe is a payment processing platform that allows businesses to accept online payments and manage transactions securely.

Stripe is a payment processing platform that allows businesses to accept online payments and manage transactions securely.

Categories: Payment Processing

Type: stripe/v1


Connections

Version: 1

Bearer Token

Properties

NameLabelTypeDescriptionRequired
tokenTokenSTRINGtrue

Actions

Create Customer

Name: createCustomer

Creates a new customer.

Properties

NameLabelTypeDescriptionRequired
emailEmailSTRINGCustomer’s email address.false
nameNameSTRINGThe customer's full name.false
descriptionDescriptionSTRINGfalse
phonePhoneSTRINGfalse
addressAddressOBJECT
Properties {STRING(city), STRING(country), STRING(line1), STRING(line2), STRING(postal_code), STRING(state)}
false

Example JSON Structure

{
  "label" : "Create Customer",
  "name" : "createCustomer",
  "parameters" : {
    "email" : "",
    "name" : "",
    "description" : "",
    "phone" : "",
    "address" : {
      "city" : "",
      "country" : "",
      "line1" : "",
      "line2" : "",
      "postal_code" : "",
      "state" : ""
    }
  },
  "type" : "stripe/v1/createCustomer"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the customer.
descriptionSTRINGDescription of the customer.
emailSTRINGEmail address of the customer.
nameSTRINGThe customer's full name.
phoneSTRINGPhone number of the customer.
addressOBJECT
Properties {STRING(city), STRING(country), STRING(line1), STRING(line2), STRING(postal_code), STRING(state)}
Customer's address.

Output Example

{
  "id" : "",
  "description" : "",
  "email" : "",
  "name" : "",
  "phone" : "",
  "address" : {
    "city" : "",
    "country" : "",
    "line1" : "",
    "line2" : "",
    "postal_code" : "",
    "state" : ""
  }
}

Create Invoice

Name: createInvoice

Creates a new invoice.

Properties

NameLabelTypeDescriptionRequired
customerCustomer IDSTRINGID of the customer who will be billed.true
currencyCurrencySTRINGCurrency used for invoice.true
descriptionDescriptionSTRINGDescription for the invoice.false

Example JSON Structure

{
  "label" : "Create Invoice",
  "name" : "createInvoice",
  "parameters" : {
    "customer" : "",
    "currency" : "",
    "description" : ""
  },
  "type" : "stripe/v1/createInvoice"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the invoice.
customerSTRINGID of the customer who will be billed.
currencySTRINGCurrency used for invoice.
descriptionSTRINGDescription for the invoice.

Output Example

{
  "id" : "",
  "customer" : "",
  "currency" : "",
  "description" : ""
}

Triggers

New Customer

Name: newCustomer

Triggers when a new customer is created.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the customer.
objectSTRINGValue is 'customer'.
descriptionSTRINGDescription of the customer.
emailSTRINGEmail of the customer.
nameSTRINGName of the customer.
phoneSTRINGPhone number of the customer.
addressOBJECT
Properties {STRING(city), STRING(country), STRING(line1), STRING(line2), STRING(postal_code), STRING(state)}
Address of the customer.

JSON Example

{
  "label" : "New Customer",
  "name" : "newCustomer",
  "type" : "stripe/v1/newCustomer"
}

New Invoice

Name: newInvoice

Triggers on a new invoice.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the invoice.
objectSTRINGValue is 'invoice'.
currencySTRINGCurrency of the invoice.
customerSTRINGID of the customer who will be billed.
customer_nameSTRINGName of the customer who will be billed.
descriptionSTRINGDescription of the invoice.

JSON Example

{
  "label" : "New Invoice",
  "name" : "newInvoice",
  "type" : "stripe/v1/newInvoice"
}

On this page