---
title: "Declare a consumer's withdrawal from the subscription (L221-21, D221-5)"
method: POST
path: "/api/v1/billing/withdraw"
tags: ["Billing"]
---

# Declare a consumer's withdrawal from the subscription (L221-21, D221-5)

`POST /api/v1/billing/withdraw`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/billing/withdraw`
- Auth: HTTP bearer

The online withdrawal function: records the declaration on the Stripe subscription and emails a timestamped acknowledgment of receipt. The refund, pro rata of the service supplied, is made from the Stripe Dashboard. 409 when no withdrawal is open; idempotent once declared.

## Request body

- WithdrawalRequest
  - `name` string, required: First and last name of the consumer.
  - `email` string, required: Address the acknowledgment of receipt is sent to.

## Response `200`

Successful Response

- ApiResponseWithdrawalResponse
  - `success` boolean, required
  - `data` WithdrawalResponse
    - `declared_at` string, required
    - `contract` string, required
    - `acknowledgment_sent` boolean, required: False when the acknowledgment email could not be sent; the declaration stands.
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)