v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Delete a customer

Delete an existing customer.

delete/v1/customers/{id}

Path parameters

idstring required

The customer ID returned at the creation stage

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

Content-Type will always be application/json

Response

200

statusinteger

{"stackTrail":"paths:/v1/customers/{id}:delete:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 200,
  "resource": {
    "type": "customer",
    "data": {
      "_service": {
        "default_gateway_id": "6788443942e960f9aa2f9ed4"
      },
      "_id": "67a2a3850cc4738d7f471d91",
      "first_name": "John23123",
      "last_name": "Customer",
      "email": "john@test.com",
      "phone": "+61111111111",
      "reference": "Customer 1",
      "archived": true,
      "_source_ip_address": "130.41.2.223",
      "payment_sources": [
        {
          "schedule": {
            "job_list": {
              "expiration_schedule_job_id": "67a2a387f29c67c511d1cceb"
            }
          },
          "type": "card",
          "card_name": "test",
          "card_number_last4": "0008",
          "card_number_bin": "51234500",
          "card_scheme": "mastercard",
          "status": "active",
          "gateway_id": "6788443942e960f9aa2f9ed4",
          "gateway_name": "MasterCard",
          "gateway_type": "MasterCard",
          "expire_month": 1,
          "expire_year": 2039,
          "created_at": "2025-02-04T23:32:22.940Z",
          "updated_at": "2025-02-07T01:41:06.451Z",
          "ref_token": "9029069515028713",
          "vault_token": "b38bc676-cbcb-427b-9b81-fed1c9bd0c1e",
          "vault_type": "permanent",
          "_id": "67a2a3860cc4738d7f471d92"
        }
      ],
      "company_id": "678842c71cd4d8d8488a83f3",
      "default_source": "67a2a3860cc4738d7f471d92",
      "status": "active",
      "updated_at": "2025-02-07T01:41:06.451Z",
      "created_at": "2025-02-04T23:32:22.990Z",
      "__v": 1
    }
  }
}