# Refund all or part of an order the signed-in user sold

Refunds by line or by amount, or the whole remainder when neither is sent.

> **Note:**

**Not fully described yet.** The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

`POST /api/v1/public/me/sales/id/refund`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Refunds by line or by amount, or the whole remainder when neither is sent. Only the order's own seller may call it, and only in the storefront shape; in the marketplace shape the app owner refunds (403). Answers 422 when the refund is not possible and 502 when Stripe did not make it; with an `Idempotency-Key` a retry returns the same refund.

## Request

| Field | Type   | Required | Constraints              | Description |
| ----- | ------ | -------- | ------------------------ | ----------- |
| `id`  | string | Yes      | matches `^[a-f0-9]{24}$` | -           |

Send the body as `application/json`. The body is optional.

| Field             | Type            | Required | Constraints                        | Description |
| ----------------- | --------------- | -------- | ---------------------------------- | ----------- |
| `lines`           | array of object | No       | at least 1 items, at most 50 items | -           |
| `lines[].lineKey` | string          | No       | at most 16 characters              | -           |
| `lines[].amount`  | integer         | No       | at least 1, at most 99999999       | -           |
| `amount`          | integer         | No       | at least 1, at most 99999999       | -           |
| `reason`          | string          | No       | at most 500 characters             | -           |
| `paymentId`       | string          | No       | at most 24 characters              | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/public/me/sales/YOUR_ID/refund" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "lines": [
    {
      "lineKey": "string",
      "amount": 1
    }
  ],
  "amount": 1,
  "reason": "string"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/me/sales/YOUR_ID/refund',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      lines: [
        {
          lineKey: 'string',
          amount: 1,
        },
      ],
      amount: 1,
      reason: 'string',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
```

```python title="Python"
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/me/sales/YOUR_ID/refund",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "lines": [
            {
                "lineKey": "string",
                "amount": 1,
            },
        ],
        "amount": 1,
        "reason": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.text
```

## Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

### Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Events

A successful call can send these [webhook events](/webhooks/overview) to the endpoints that subscribe to them:

- [`order.refunded`](/webhooks/overview#when-each-event-fires)

## Related

- [All Me operations](/http-api/reference/me)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `me.sales.refund.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
