Updating a setup intent

If you need to update a setup intent, send a POST request to the v1/setup-intents/{id} endpoint of the setup intents API. You can update the following values:

  • customerId

  • usage

For example, you can update the customerId if you need to change the customer profile that the setup intent is associated with. You can also update the usage value, which indicates how the setup intent will be used in the future. The usage value should always be set to ON_SESSION or omitted from the request body for customer-initiated transactions. Update the usage value to OFF_SESSION for merchant-initiated transactions. For more information, see Creating a setup intent for future merchant-initiated transactions.

Example request body

{
    "usage": "ON_SESSION", 1
    "customerId": "46ed1272-a628-4d7a-9f7b-d27d8e88cf18", 2
    "sessionSecret": "SI_1fdd6e15847148538862b755a23816d2_SECRET_1234abw125"
}

1

Used to determine if the customer will save the payment method for future use.

2

The unique identifier for the customer record that identifies the customer in the Toast platform.


Example response body

{
    "id": "1fdd6e15-8471-4853-8862-b755a23816d2",
    "customerId": "46ed1272-a628-4d7a-9f7b-d27d8e88cf18",
    "sessionSecret": "SI_1fdd6e15847148538862b755a23816d2_SECRET_1234abw125",
    "paymentMethodId": null,
    "status": "REQUIRES_PAYMENT_METHOD", 1
    "usage": "ON_SESSION", 
    "creationDate": "2024-03-26T16:17:27Z"
    "standingInstructionType": null,
    "mandateId": null
}

1

The status of the setup intent. For more information, see Setup intent statuses.