CRcreem
Customer Credits - Accounts

Close an account

Changed on

Permanently close an account. This action cannot be undone.

post/v1/customer-credits/accounts/{id}/close

Request

Path parameters

idstring required

Response

Account closed

idstring required

Account ID

store_idstring required

Store ID

customer_idstring required

Owner ID

namestring required

Account name

unit_labelstring required

Unit label

status'active' | 'frozen' | 'closed' required

Account status

created_atstring required

Creation timestamp

updated_atstring required

Last update timestamp

Example response

{
  "id": "cca_abc123",
  "customer_id": "cust_abc123",
  "name": "default",
  "unit_label": "credits"
}

Changes

  • 071301350724Revision changes
    • info

      api tag Customer Credits - Accounts added

    • info

      api tag Customer Credits - Accounts (Experimental) removed

  • aa593160d96cRevision changes
    • breaking

      the ///// response's property type changed from object to string for status

    • breaking

      the ///// response's property type changed from object to string for status