GET /v1/setup_intents/{intent}

Retrieves the details of a SetupIntent that has previously been created.

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

Servers

Path parameters

Name Type Required Description
intent String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description
client_secret String No

The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.

expand[] Array No

Specifies which fields in the response should be expanded.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.