01.software Docs

withdrawCustomer

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/customers/withdraw

Customer self action requiring the current password and a non-guest, unsuspended password account. Active membership obligations block withdrawal. Server credentials cannot delegate this operation.

Authorization

publishableKeycustomerBearerAuth
headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

headerAuthorizationBearer <JWT>

Customer JWT for same-tenant authenticated customer actions

Request Body

application/json
  1. body
currentPassword*string
Length1 <= length <= 128

Response Body

Successful operation

application/json
  1. response
withdrawnAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatdate-time

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/customers/withdraw' \  -H 'Content-Type: application/json' \  -d '{  "currentPassword": "string"}'
Example Response
{  "withdrawnAt": "2019-08-24T14:15:22Z"}