Sample - Stripe API
DELETE/v1/terminal/locations/{location}

Delete a Terminal location

Deletes a Terminal location and removes the location object from active use. Supply the location identifier for the location you want to delete; the request body has no fields.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
locationstringrequired
The unique identifier of the location to delete. Must be no longer than 5000 characters.

2 status codes
200Returns a deleted-location object containing `deleted`, the location `id`, and the object type `terminal.location`.
deletedbooleanrequired
Always true for a deleted object
Allowed:true
idstringrequired
Unique identifier for the object.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:terminal.location
defaultError response.
errorobjectrequired

Error handling

location must be a string no longer than 5000 characters and must identify the location to delete. The request body does not define any fields, so send no update properties.