> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.mixlayer.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mixlayer.com/_mcp/server.

# Redeem a promo code

POST https://api.mixlayer.com/v1/organizations/{org_id}/redeem_promo
Content-Type: application/json

Reference: https://docs.mixlayer.com/api-reference/platform-api/billing-accounts/redeem-promo-code

## Authentication

- `Authorization` header (bearer token, required) — Console user session or Mixlayer API key supplied as a Bearer token.

## Request

### Path parameters

- `org_id` (string, required) — Organization ID

### Body (application/json)

This endpoint expects a RedeemPromoCodeRequest.

- `code` (string, required) — Human-readable promo code to redeem.

## Response

### 200

Promo redemption receipt

- `data` (ApiDataResponsePromoRedemptionData, required) — Public receipt for a promo redemption attempt.

## Errors

### 400 Bad Request Error

The request body contains malformed JSON or invalid values.

- `error` (ApiErrorBody, required) — Structured error details.

### 401 Unauthorized Error

Authentication is missing or invalid.

- `error` (ApiErrorBody, required) — Structured error details.

### 403 Forbidden Error

The authenticated principal cannot perform this operation.

- `error` (ApiErrorBody, required) — Structured error details.

### 409 Conflict Error

Promo code was already redeemed or cannot be redeemed

- `error` (ApiErrorBody, required) — Structured error details.

### 413 Content Too Large Error

The request body exceeds the configured size limit.

- `error` (ApiErrorBody, required) — Structured error details.

### 415 Unsupported Media Type Error

The request does not have a JSON content type.

- `error` (ApiErrorBody, required) — Structured error details.

### 422 Unprocessable Entity Error

The JSON body does not match the request schema or contains a rejected field value.

- `error` (ApiErrorBody, required) — Structured error details.

### 500 Internal Server Error

An unexpected server or database error occurred.

- `error` (ApiErrorBody, required) — Structured error details.

### 503 Service Unavailable Error

Credit redemption is unavailable

- `error` (ApiErrorBody, required) — Structured error details.

## Types

### ApiDataResponsePromoRedemptionData

Public receipt for a promo redemption attempt.

- `billing_account_id` (string, required) — Billing account receiving the promotional credit.
- `created_at` (datetime, required) — Time the promo redemption was created.
- `credit_ends_at` (datetime, required) — End of the promotional credit validity period.
- `credit_starts_at` (datetime, required) — Start of the promotional credit validity period.
- `id` (string, required) — Promo redemption ID.
- `organization_id` (string, required) — Organization receiving the promotional credit.
- `promo_code_id` (string, required) — Redeemed promo code ID.
- `status` (enum, required) — Current promo redemption status.
  - Allowed values: `pending`, `succeeded`
- `redeemed_at` (datetime, optional, nullable) — Time the promo redemption succeeded, or null while pending.

### ApiErrorBody

Structured error details returned by the platform API.

- `message` (string, required) — Human-readable error message.
- `code` (string, optional, nullable) — Stable machine-readable error code, when available.
- `details` (any, optional) — Error-specific structured context, when available.

## Examples

**Request**

```json
{
  "code": "string"
}
```

**Response**

```json
{
  "data": {
    "billing_account_id": "string",
    "created_at": "2024-01-15T09:30:00Z",
    "credit_ends_at": "2024-01-15T09:30:00Z",
    "credit_starts_at": "2024-01-15T09:30:00Z",
    "id": "string",
    "organization_id": "string",
    "promo_code_id": "string",
    "status": "pending",
    "redeemed_at": "2024-01-15T09:30:00Z"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.mixlayer.com/v1/organizations/org_id/redeem_promo"

payload = { "code": "string" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.mixlayer.com/v1/organizations/org_id/redeem_promo';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"code":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixlayer.com/v1/organizations/org_id/redeem_promo"

	payload := strings.NewReader("{\n  \"code\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.mixlayer.com/v1/organizations/org_id/redeem_promo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.mixlayer.com/v1/organizations/org_id/redeem_promo")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.mixlayer.com/v1/organizations/org_id/redeem_promo', [
  'body' => '{
  "code": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```