Skip to Content

Stripe Delete Activity

Introduction

A Stripe Delete activity, using its Stripe connection, deletes object data from Stripe and is intended to be used as a target to consume data in an operation.

Create a Stripe Delete Activity

An instance of a Stripe Delete activity is created from a Stripe connection using its Delete activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing Stripe Delete activity can be edited from these locations:

Configure a Stripe Delete Activity

Follow these steps to configure a Stripe Delete activity:

Step 1: Enter a Name and Select an Object

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

Stripe Delete Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Stripe Delete activity and must not contain forward slashes / or colons :.

  • Select an Object: This section displays objects available in the Stripe endpoint.

    • Selected Object: After an object is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the Stripe endpoint. This may be useful if objects have been added to Stripe. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the Stripe endpoint:

      • Name: The name of the object.

      • Description: The description of the object.

    Tip

    If the table does not populate with available objects, the Stripe connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a Sub-object

In this step, select a sub-object. Each user interface element of this step is described below.

Stripe Delete Activity Configuration Step 2

  • Select a Sub-object: This section displays sub-objects available in the Stripe endpoint.

    • Selected Object: The object selected in the previous step is listed here.

    • Select a Sub-object: After a sub-object is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of sub-objects. The search is not case-sensitive. If sub-objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload sub-objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload sub-objects from the Stripe endpoint. This may be useful if sub-objects have been added to Stripe. This action refreshes all metadata used to build the table of sub-objects displayed in the configuration.

    • Selecting a Sub-object: Within the table, click anywhere on a row to select a sub-object. Only one sub-object can be selected. The information available for each sub-object is fetched from the Stripe endpoint:

      • Name: The name of the sub-object.

      • Description: The description of the sub-object.

    Tip

    If the table does not populate with available sub-objects, the Stripe connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Select an Action

In this step, select an action. Each user interface element of this step is described below.

Stripe Delete Activity Configuration Step 3

  • Select an Action: This section displays actions available in the Stripe endpoint.

    • Selected Sub-object: The sub-object selected in the previous step is listed here.

    • Select Action: After an action is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of actions. The search is not case-sensitive. If actions are already displayed within the table, the table results are filtered in real time with each keystroke. To reload actions from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload actions from the Stripe endpoint. This may be useful if actions have been added to Stripe. This action refreshes all metadata used to build the table of actions displayed in the configuration.

    • Selecting an Action: Within the table, click anywhere on a row to select an action. Only one action can be selected. The information available for each action is fetched from the Stripe endpoint:

      • Name: The name of the action.

      • Description: The description of the action.

    Tip

    If the table does not populate with available actions, the Stripe connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 4: Review the Data Schemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

Stripe Delete Activity Configuration Step 4

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The Stripe connector uses the Stripe API. Refer to the API documentation for information on the schema nodes and fields.

  • Edit: Click the edit icon Edit icon above the response data schema to enter the edit mode for the response schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All occurrences of nodes and fields is set as [0, 1] cardinality. Changes made to the data schemas must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint.

    Note

    If your Stripe instance uses custom fields, you must edit the response schema to include a metadata node containing any custom fields. Otherwise, you will receive a Success with Warning operation status. For more information on using the metadata node, see the Stripe API documentation.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Stripe endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Stripe Delete activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Stripe Delete activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.