Stripe

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all customers

1. In the Configure connector task dialog, click Entities .
2. Select Customer from the Entity List.
3. Select the List operation, and then click Done .
4. In the Task Input section of the Connectors task, you can set the filterClause as per the customer requirement.

You must use single quotes (') to enclose the value for a filterClause . You can use the filterClause to filter records based on the columns.

Example - Get customer details

1. In the Configure connector task dialog, click Entities .
2. Select Customer from the Entity list.
3. Select the Get operation, and then click Done .
4. In the Task Input section of the Connectors task, click entityId and then enter cus_OxHsz0u5bCGWuy in the Default Value field.

   Here, cus_OxHsz0u5bCGWuy is a unique record ID in the Customer entity.

Example - Create a customer

1. In the Configure connector task dialog, click Entities .
2. Select Customer from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Name": "abc"
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "cus_OxIqiMh1W335rE"
   }

Example - Create a refund

1. In the Configure connector task dialog, click Entities .
2. Select Refunds from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Charge": "ch_3OU27zANHgX3SHp73HqiDsh3",
     "Amount": 10.0
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "re_3OU27zANHgX3SHp73nxqZMF2"
   }

Example - Create a card

1. In the Configure connector task dialog, click Entities .
2. Select Cards from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "CustomerId": "cus_OmptWC2kb2264y",
     "Token": "tok_1O9kUPANHgX3SHp7WcrPumVI"
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "card_1O9kUPANHgX3SHp7Q8Hsk35F",
     "CustomerId": "cus_OmptWC2kb2264y"
   }

Example - Create a price

1. In the Configure connector task dialog, click Entities .
2. Select Prices from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Currency": "usd",
     "Product": "prod_OlNe53LwNydXSx",
     "UnitAmount": 1200.0
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "price_1OAR1TANHgX3SHp7EeiZTW9h"
   }

Example - Create an invoice

1. In the Configure connector task dialog, click Entities .
2. Select Invoices from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "CustomerId": "cus_OhvXm2EI9bsFyN"
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "in_1OXR9gANHgX3SHp7wHdnEe7U"
   }

Example - Create an invoice item

1. In the Configure connector task dialog, click Entities .
2. Select InvoiceItems from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Customer": "cus_OksFS6F8HS7o5O",
     "Currency": "usd",
     "Amount": 1000.0
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "ii_1OZAfAANHgX3SHp7xsd9o7Qm"
   }

Example - Create a quote

1. In the Configure connector task dialog, click Entities .
2. Select Quotes from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "CustomerId": "cus_POGecLC3f3hwk2"
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "qt_1OZU92ANHgX3SHp75zJzMSvC"
   }

Example - Create an account

1. In the Configure connector task dialog, click Entities .
2. Select Accounts from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Type": "standard"
   }

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "acct_1OZBcsQbE7mBlkdN"
   }

Example - Create a payment intent

1. In the Configure connector task dialog, click Entities .
2. Select PaymentIntent from the Entity list.
3. Select the Create operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "PaymentMethod": "pm_1OXN5YANHgX3SHp7Q5Y0rb39",
   "Currency": "usd",
   "Amount": 1500.0
   }

   If the integration is successful, your connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
   "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
   }

Example - Update customer details

1. In the Configure connector task dialog, click Entities .
2. Select Customer from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "Name": "Charlie"
   }

5. Click entityId , and then enter cus_OxHsz0u5bCGWuy in the Default Value field.

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

   {
   "Id": "cus_OxHsz0u5bCGWuy"
   }

Example - Update a payment intent

1. In the Configure connector task dialog, click Entities .
2. Select PaymentIntent from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Description": "Payment Intent"
   }

5. Set the entityId to pi_3OWzKoANHgX3SHp70nE8QKyn. To set the entityId, click entityId , and then enter pi_3OWzKoANHgX3SHp70nE8QKyn in the Default Value field.

   Instead of specifying the entityId , you can also set the filterClause to 'pi_3OWzKoANHgX3SHp70nE8QKyn' .

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Id": "pi_3OWzKoANHgX3SHp70nE8QKyn"
   }

Example - Update card details

1. In the Configure connector task dialog, click Entities .
2. Select Cards from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "AddressCountry": "US",
     "Id": "card_1O9kUPANHgX3SHp7Q8Hsk35F",
     "CustomerId": "cus_OmptWC2kb2264y"
   }

5. Set the filterClause to CustomerId = 'cus_OmptWC2kb2264y' and Id = 'card_1O9kUPANHgX3SHp7Q8Hsk35F' . To set the filterClause, click filterClause and then enter CustomerId = 'cus_OmptWC2kb2264y' and Id = 'card_1O9kUPANHgX3SHp7Q8Hsk35F' in the Default Value field.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "result": [{
       "Id": "card_1O9kUPANHgX3SHp7Q8Hsk35F",
       "CustomerId": "cus_OmptWC2kb2264y"
     }]
   }

Example - Update price details

1. In the Configure connector task dialog, click Entities .
2. Select Prices from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Nickname": "Price Update"
   }

5. Set the entityId to price_1O9nTjANHgX3SHp7Zr552abc. To set the entityId, click entityId and then enter price_1O9nTjANHgX3SHp7Zr552abc in the Default Value field.

   Instead of specifying the entityId , you can also set the filterClause to 'price_1O9nTjANHgX3SHp7Zr552abc' .

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
    "Id": "price_1O9nTjANHgX3SHp7Zr552abc"
   }

Example - Update an invoice

1. In the Configure connector task dialog, click Entities .
2. Select Invoices from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Description": "Invoice for car"
   }

5. Set the entityId to in_1OA74xANHgX3SHp7YbC6x9R6. To set the entityId, click entityId and then enter in_1OA74xANHgX3SHp7YbC6x9R6 in the Default Value field.

   Instead of specifying the entityId , you can also set the filterClause to 'in_1OA74xANHgX3SHp7YbC6x9R6' .

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Id": "in_1OA74xANHgX3SHp7YbC6x9R6"
   }

Example - Update an invoice item

1. In the Configure connector task dialog, click Entities .
2. Select InvoiceItems from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Quantity": 3.0
   }

5. Set the entityId to ii_1OZAfAANHgX3SHp7xsd9o7Qm. To set the entityId, click entityId and then enter ii_1OZAfAANHgX3SHp7xsd9o7Qm in the Default Value field.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Id": "ii_1OZAfAANHgX3SHp7xsd9o7Qm"
   }

Example - Update a quote

1. In the Configure connector task dialog, click Entities .
2. Select Quotes from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "CustomerId": "cus_PQuEGGfutajbAs"
   }

5. Set the entityId to qt_1Oc2VaANHgX3SHp7PaM9Ph9o. To set the entityId, click entityId and then enter qt_1Oc2VaANHgX3SHp7PaM9Ph9o in the Default Value field.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Id": "qt_1Oc2VaANHgX3SHp7PaM9Ph9o"
   }

Example - Update account details

1. In the Configure connector task dialog, click Entities .
2. Select Accounts from the Entity list.
3. Select the Update operation, and then click Done .
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "BusinessProfileName": "StagingName"
   }

5. Set the entityId to acct_1OZBcsQbE7mBlkdN. To set the entityId, click entityId and then enter acct_1OZBcsQbE7mBlkdN in the Default Value field.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   {
     "Id": "acct_1OZBcsQbE7mBlkdN"
   }

Example - Delete a customer

1. In the Configure connector task dialog, click Entities .
2. Select Customer from the Entity list.
3. Select the Delete operation, and then click Done .
4. Click entityId and then enter cus_OxIqiMh1W335rE in the Default Value field.

If entity has two composite business or primary keys, instead of specifying the entityId , you can set the filterClause to id='cus_OxIqiMh1W335rE' .