> ## Documentation Index
> Fetch the complete documentation index at: https://readme.amana-dev.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get active promo

> Get the promo currently active on the user's account.

## Response

`200` Success.

<ResponseField name="ok" type="boolean" />

<ResponseField name="promoCode" type="string" />

<ResponseField name="title" type="string" />

<ResponseField name="termsAndConditionsLink" type="string" />

<ResponseField name="amount" type="number" />

<ResponseField name="currency" type="string" />

<ResponseField name="criteria" type="object[]">
  <Expandable title="properties">
    <ResponseField name="key" type="string" />

    <ResponseField name="label" type="string" />

    <ResponseField name="status" type="boolean" />

    <ResponseField name="action" type="object">
      <Expandable title="properties">
        <ResponseField name="label" type="object" />

        <ResponseField name="deeplink" type="string" />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="activatedAt" type="string" />

## Possible Errors

| Error | Possible cause | What to do |
| - | - | - |
| 400 | Invalid or missing field | Check the request against the schema. |
| 401 | Token missing or expired | Log in again or use the refresh token. |
| 403 | IP not whitelisted, or account restricted | Confirm your IP is whitelisted; otherwise contact Amana. |
| 429 / 5xx | Rate limit, or temporary issue on our side | Retry with backoff; contact support if it persists. |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://gateway.amana.io/promo-codes/active' \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  url = "https://gateway.amana.io/promo-codes/active"
  headers = {"Authorization": "Bearer <token>"}

  response = requests.request("GET", url, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://gateway.amana.io/promo-codes/active', {
    method: 'GET',
    headers: {"Authorization": "Bearer <token>"},
  });
  console.log(await response.json());
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "ok": true,
    "promoCode": "<string>",
    "title": "<string>",
    "termsAndConditionsLink": "<string>",
    "amount": 123.45,
    "currency": "<string>",
    "criteria": [
      {
        "key": "<string>",
        "label": "<string>",
        "status": true,
        "action": {
          "label": {},
          "deeplink": "<string>"
        }
      }
    ],
    "activatedAt": "<string>"
  }
  ```

  ```json 400 theme={null}
  {
    "error": "<string>",
    "message": "<string>",
    "details": {}
  }
  ```

  ```json 401 theme={null}
  {
    "error": "<string>",
    "message": "<string>",
    "details": {}
  }
  ```

  ```json 403 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 429 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.