Delete the default payment method for a customer

Deletes a customer's default payment method.

SecurityOAuth2
Request
path Parameters
contextName
required
string

The unique integration provided context name that the default payment method should be deleted for.

Example: checkout
id
required
string <uuid>

The unique identifier of the customer record.

Example: 8dce2c23-283d-4a2a-8a11-d868a92a42d2
header Parameters
Toast-Restaurant-External-ID
required
string <uuid>

The identifier of the location.

Example: 8dce2c23-283d-4a2a-8a11-d868a92a42d2
Responses
200

Successful operation. Default payment method deleted.

401

Your client is not authorized to use the API endpoint.

403

Your client is not authorized to use the API endpoint.

404

The customer record does not exist, or no default payment method is set for the context name.

500

Internal server error.

delete/v1/customers/{id}/payment-methods/defaults/{contextName}
Request samples
curl -i -X DELETE \
  'https://toast-api-server/v1/customers/{id}/payment-methods/defaults/{contextName}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: 8dce2c23-283d-4a2a-8a11-d868a92a42d2'
Response samples
application/json
{
  • "paymentMethodId": "579adc3e-49b6-4501-befd-b900b99575f5",
  • "contextName": "checkout"
}