Delete Payment

Delete a payment for a user by ID

Endpoint Details

DELETE /users/payments/purge/{userId}/{paymentId}

Path Parameters

Name	Type	Description	Required
userId	string	Existing user identifier, returned upon session creation or update
paymentId	string	Existing payment identifier of the user

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer <YOUR_ACCESS_TOKEN>

Response Details

Field	Type	Description
statusCode	number	HTTP status code of the response
message	string	A brief message describing the result of the API call
metadata	metaDataObject	Contains metadata about the API call
data.deleted	boolean	States if delete succeded or not
data.message	string	Delete message

Metadata Object

Field	Type	Description
languages	Array<string>	List of supported languages for the response, e.g. ["en"]
timestamp	string	Unix timestamp (in milliseconds) when the response was generated
timezone	string	Timezone used for the response, always "UTC"
requestId	string	Unique identifier for the API request. Used for debugging and support
path	string	API path
version	string	API version used for the request

Sample Request and Response

curl --location 'https://staging.api.liquidcommerce.cloud/users/payments/purge' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "customerId": "usrid_123abc456def",
    "paymentMethodId": "paymentid_123abc456def",
    "isDefault": true
}'

200

{
    "statusCode": 200,
    "message": "Deleting a payment method",
    "metadata": {
        "languages": [
            "en"
        ],
        "timestamp": 1731600946784,
        "timezone": "UTC",
        "requestId": "reqid_123abc45def",
        "path": "/api/users/payments/purge/usr_123abc456def/paymentid_123abc456def",
        "version": "1.7.0"
    },
    "data": {
        "deleted": false,
        "message": "There's no Payment method with the ID provided for this customer"
    }
}