# Benefits API

A `benefit` is represented as an object with the following structure:

```javascript
{
  enabled: Boolean,
  creditAmount: Number,
  icon: String,
  displayOnLandingPage: Boolean,
  description: String,
  name: String,
  type: String
}
```

{% hint style="info" %}
When making a request to the Benefits API, all benefits will be returned as objects within a `benefits` array.
{% endhint %}

## Endpoints & Methods

## Get all benefits

<mark style="color:blue;">`GET`</mark> `https://public.inveterateapi.com/benefits`

{% tabs %}
{% tab title="200: OK " %}

```json
{
  "success": true,
  "data": {
    "benefits": [
      {
        "enabled": true,
        "creditAmount": 10,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/anniversary_credits.svg",
        "displayOnLandingPage": true,
        "description": "Earn credits every year, just for being a member of the program",
        "name": "Anniversary Credits",
        "type": "ANNIVERSARY_CREDITS"
      },
      {
        "enabled": false,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/discounts.svg",
        "displayOnLandingPage": false,
        "description": "Take advantage of exclusive member-only discounts on certain products.",
        "name": "Member Only Discounts",
        "type": "DISCOUNTS"
      },
      {
        "enabled": false,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/early_access.svg",
        "displayOnLandingPage": false,
        "description": "Get early access to new product releases before everyone else. Never run the risk of something being sold out!",
        "name": "Early Access",
        "type": "EARLY_ACCESS"
      },
      {
        "enabled": false,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/exclusive.svg",
        "displayOnLandingPage": false,
        "description": "Get access to products that are only eligible for purchase by members!",
        "name": "Exclusive Access",
        "type": "EXCLUSIVE"
      },
      {
        "enabled": false,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/shipping.svg",
        "displayOnLandingPage": false,
        "description": "Get free shipping on every order, every time.",
        "name": "Free Shipping",
        "type": "FREE_SHIPPING"
      },
      {
        "enabled": false,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/member_only_pricing.svg",
        "displayOnLandingPage": false,
        "description": "Take advantage of special member only pricing on certain products. Why pay full price if you don’t have to!",
        "name": "Member Only Pricing",
        "type": "MEMBER_ONLY_PRICING"
      },
      {
        "enabled": true,
        "creditAmount": 5,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/referrals.svg",
        "displayOnLandingPage": true,
        "description": "Invite a friend to become a member and receive $5 when they sign up!",
        "name": "Store Credits for Program Referral",
        "type": "REFERRALS"
      },
      {
        "enabled": false,
        "creditAmount": 10,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/store_credits.svg",
        "displayOnLandingPage": false,
        "description": "You’ll see $10 in store credit automatically hit your membership account every month.",
        "name": "Recurring Store Credits",
        "type": "SCHEDULED_STORE_CREDITS"
      },
      {
        "enabled": true,
        "creditAmount": 10,
        "icon": "https://d672z8ecdnbl.cloudfront.net/assets/iconography/custom/store_credits.svg",
        "displayOnLandingPage": true,
        "description": "Receive $10 in store credits just for signing up for the program.",
        "name": "Sign Up Store Credits",
        "type": "SIGNUP_STORE_CREDITS"
      }
    ],
    "count": 9
  },
  "errors": []
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.inveterate.com/dev/api-reference-docs/legacy-public-api-reference/benefits-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.