Inveterate Public API 2.0 Reference

https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference
Admin
Inveterate Public API 2.0 is an updated API for Inveterate merchants, offering significant...
Tokens:37,799
Snippets:114
Trust Score:7.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Making a GET Request with API Key (Curl)

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/index

This example demonstrates how to make a GET request to the merchant endpoint using Curl. It includes the necessary API URL and the authentication header with the API key.

```shell
curl -X GET "https://public.inveterateapi.com/v2.0/merchant"
-H "X-Inveterate-Api-Key: {api_key}"
```

--------------------------------

### GET /v2.0/storefront/benefits

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/storefront/benefits

Retrieves a list of all available benefits.

```APIDOC
## GET /v2.0/storefront/benefits

### Description
Retrieves a list of all available benefits.

### Method
GET

### Endpoint
/v2.0/storefront/benefits

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of benefits to return.
- **offset** (integer) - Optional - The number of benefits to skip before starting to collect the result set.

### Request Example
```json
{
  "example": "GET /v2.0/storefront/benefits?limit=10&offset=0"
}
```

### Response
#### Success Response (200)
- **benefits** (array) - A list of benefit objects.
  - **id** (string) - The unique identifier for the benefit.
  - **name** (string) - The name of the benefit.
  - **description** (string) - A detailed description of the benefit.

#### Response Example
```json
{
  "example": "{\"benefits\":[{\"id\":\"benefit_123\",\"name\":\"Health Insurance\",\"description\":\"Comprehensive health coverage.\"},{\"id\":\"benefit_456\",\"name\":\"Retirement Plan\",\"description\":\"401(k) matching program.\"}] }"
}
```
```

--------------------------------

### GET /v2.0/admin/benefits

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/benefits

Retrieves a list of all benefits.

```APIDOC
## GET /v2.0/admin/benefits

### Description
Retrieves a list of all benefits.

### Method
GET

### Endpoint
/v2.0/admin/benefits

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of benefits to return.
- **offset** (integer) - Optional - The number of benefits to skip before returning results.

### Request Example
```json
{
  "limit": 10,
  "offset": 0
}
```

### Response
#### Success Response (200)
- **benefits** (array) - A list of benefit objects.
  - **id** (integer) - The unique identifier of the benefit.
  - **type** (string) - The type of benefit.
  - **description** (string) - A description of the benefit.

#### Response Example
```json
{
  "benefits": [
    {
      "id": 1,
      "type": "health",
      "description": "Comprehensive health insurance."
    },
    {
      "id": 2,
      "type": "dental",
      "description": "Dental care coverage."
    }
  ]
}
```
```

--------------------------------

### Get All Members with Pagination using Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Shows how to retrieve members with cursor-based pagination using cURL. It includes examples for fetching the first page and subsequent pages using the `lastCustomerId` parameter.

```bash
# Get first page of members (limit 50)
curl -X GET "https://public.inveterateapi.com/v2.0/admin/members?limit=50" \
  -H "X-Inveterate-Api-Key: your_api_key_here"

# Response
{
  "message": "Members retrieved successfully",
  "data": {
    "members": [
      {
        "customerId": "7733560541315",
        "email": "customer@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "credit": 150,
        "status": "active",
        "joinedAt": "2024-03-01T12:00:00.000Z",
        "orderCount": 5,
        "totalSpend": 500.00
      }
    ],
    "lastCustomerId": "7733560541315"
  }
}

# Get next page using lastCustomerId
curl -X GET "https://public.inveterateapi.com/v2.0/admin/members?limit=50&lastCustomerId=7733560541315" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

--------------------------------

### Webhook Payload Example and Handler - JavaScript

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Illustrates the structure of a webhook payload for a 'customer.payment_failed' event and provides an example of an Express.js handler for processing such webhooks. It includes payload data, metadata, and a basic signature verification and processing logic.

```javascript
// Example: customer.payment_failed webhook payload
{
  "payload": {
    "customerId": "7733560541315",
    "merchantId": "merchant_12345",
    "createdAt": "2025-05-30T11:01:00.674Z",
    "updatedAt": "2025-05-30T11:01:00.674Z",
    "customer": {
      "id": "7733560541315",
      "email": "customer@example.com",
      "phoneNumber": "+1-555-123-4567"
    },
    "detail": {
      "amount": 100,
      "currency": "USD",
      "errorMessage": "Payment method was revoked",
      "billingDate": "2025-06-30T07:00:00.000Z",
      "billingAttempts": 3,
      "billingTierId": "premium_tier_abc123",
      "isFinal": true
    }
  },
  "metadata": {
    "id": "1c77f905-8a5c-eaf7-ab62-1db3405eec81",
    "retryCount": 0,
    "shopDomain": "example.myshopify.com",
    "topic": "customer.payment_failed",
    "version": "2025-06",
    "triggerredAt": "2025-05-30T11:01:00.713Z"
  }
}

// Express.js webhook handler example
app.post('/webhooks/payment-failed', (req, res) => {
  const { payload, metadata } = req.body;

  // Verify webhook authenticity using token
  const signature = req.headers['x-inveterate-signature'];
  if (!verifyWebhookSignature(signature, req.body)) {
    return res.status(401).send('Invalid signature');
  }

  // Process payment failure
  const { customerId, customer, detail } = payload;
  console.log(`Payment failed for ${customer.email}: ${detail.errorMessage}`);

  if (detail.isFinal) {
    // Handle final payment failure (e.g., suspend subscription)
    handleFinalPaymentFailure(customerId);
  }

  res.status(200).send('Webhook received');
});
```

--------------------------------

### Webhooks Overview

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/webhooks

Get, create, update, and delete webhook subscriptions. Use these to build third-party integrations.

```APIDOC
## Webhooks API

### Description
Manages webhook subscriptions for third-party integrations.

### Method
GET, POST, PUT, DELETE

### Endpoint
/api/webhooks

### Parameters
(Details for specific operations like GET, POST, PUT, DELETE would be elaborated here, including path, query, and request body parameters.)

### Request Example
(Example for creating a webhook subscription)
```json
{
  "url": "https://example.com/webhook",
  "topics": ["customer.joined.paid_tier", "customer.updated"]
}
```

### Response
#### Success Response (200)
- **subscriptions** (array) - A list of webhook subscriptions.

#### Response Example
```json
{
  "subscriptions": [
    {
      "id": "wh_123",
      "url": "https://example.com/webhook",
      "topics": ["customer.joined.paid_tier", "customer.updated"],
      "created_at": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### GET /v2.0/admin/tiers

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/tiers

Retrieves a list of all available tiers.

```APIDOC
## GET /v2.0/admin/tiers

### Description
Retrieves a list of all available tiers.

### Method
GET

### Endpoint
/v2.0/admin/tiers

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of tiers to return per page.
- **offset** (integer) - Optional - Number of tiers to skip before starting to collect the result set.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **tiers** (array) - A list of tier objects.
  - **id** (string) - The unique identifier for the tier.
  - **name** (string) - The name of the tier.
  - **description** (string) - A description of the tier.
  - **created_at** (string) - The timestamp when the tier was created.
  - **updated_at** (string) - The timestamp when the tier was last updated.

#### Response Example
```json
{
  "example": "{\"tiers\": [{\"id\": \"tier_1\", \"name\": \"Basic Tier\", \"description\": \"Entry-level tier with basic features.\", \"created_at\": \"2023-10-27T10:00:00Z\", \"updated_at\": \"2023-10-27T10:00:00Z\"}] }"
}
```
```

--------------------------------

### Create Free Tier Member using Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Provides an example of creating a new member in a free tier using a cURL POST request with a JSON payload. It includes options for credits and can be used to upgrade members to spend-based tiers.

```bash
curl -X POST "https://public.inveterateapi.com/v2.0/admin/members" \
  -H "X-Inveterate-Api-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ \
    "customerId": "7733560541316", \
    "referrals": false, \
    "segmentId": "free_tier_001", \
    "overrideSpendThreshold": false, \
    "keepInSpendBasedTier": false, \
    "credits": 50, \
    "birthday": "1990-05-15" \
  }'

# Success response
{
  "message": "Member created successfully",
  "data": {
    "customerId": "7733560541316",
    "segmentId": "free_tier_001",
    "credits": 50
  }
}

# Error response example
{
  "message": "Customer already exists in loyalty program",
  "data": {
    "error": "DUPLICATE_MEMBER",
    "customerId": "7733560541316"
  }
}
```

--------------------------------

### Get Member Data (Storefront) - Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Retrieves detailed member information from the storefront perspective using a GET request. This endpoint requires the member's customer ID and an API key for authentication. The response includes personal details, credit balance, tier information, and associated benefits.

```bash
curl -X GET "https://public.inveterateapi.com/v2.0/storefront/members/7733560541315" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

--------------------------------

### Get Single Member Details using Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Demonstrates how to retrieve detailed information for a specific member using their customer ID via a cURL GET request. The response includes various attributes of the member's loyalty account.

```bash
curl -X GET "https://public.inveterateapi.com/v2.0/admin/members/7733560541315" \
  -H "X-Inveterate-Api-Key: your_api_key_here"

# Response
{
  "message": "Member retrieved successfully",
  "data": {
    "merchantId": "merchant_12345",
    "customerId": "7733560541315",
    "accountState": "active",
    "email": "customer@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "credit": 150,
    "creditsEarned": 250,
    "orderCount": 5,
    "totalSpend": 500.00,
    "revenue": 475.00,
    "joinedAt": "2024-03-01T12:00:00.000Z",
    "lastPurchaseAt": "2024-10-01T15:30:00.000Z",
    "numberOfCreditRedemptions": 3,
    "lastCreditRedemptionAt": "2024-09-15T10:00:00.000Z",
    "referrals": 2,
    "notes": "VIP customer"
  }
}
```

--------------------------------

### Admin - Webhooks Management

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

APIs for managing webhook subscriptions, including getting, creating, and updating them.

```APIDOC
## GET /v2.0/admin/webhook-subscriptions

### Description
Retrieve all webhook subscriptions configured for the merchant account.

### Method
GET

### Endpoint
`/v2.0/admin/webhook-subscriptions`

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -X GET "https://public.inveterateapi.com/v2.0/admin/webhook-subscriptions" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Object containing webhook subscriptions.
  - **subscriptions** (array) - List of webhook subscriptions.
    - **id** (string) - Unique identifier for the subscription.
    - **name** (string) - Name of the webhook subscription.
    - **topic** (string) - The event topic the webhook subscribes to.
    - **callbackUrl** (string) - The URL to send webhook events to.
    - **createdAt** (string) - Timestamp when the subscription was created.
    - **updatedAt** (string) - Timestamp when the subscription was last updated.

#### Response Example
```json
{
  "message": "Webhook subscriptions retrieved successfully",
  "data": {
    "subscriptions": [
      {
        "id": "webhook_123",
        "name": "Customer Joined Webhook",
        "topic": "customer.joined.paid_tier",
        "callbackUrl": "https://example.com/webhooks/customer-joined",
        "createdAt": "2024-05-01T10:00:00.000Z",
        "updatedAt": "2024-05-01T10:00:00.000Z"
      },
      {
        "id": "webhook_456",
        "name": "Payment Failed Webhook",
        "topic": "customer.payment_failed",
        "callbackUrl": "https://example.com/webhooks/payment-failed",
        "createdAt": "2024-05-15T14:30:00.000Z",
        "updatedAt": "2024-05-15T14:30:00.000Z"
      }
    ]
  }
}
```
```

```APIDOC
## POST /v2.0/admin/webhook-subscriptions

### Description
Create a new webhook subscription to receive real-time notifications for specific events.

### Method
POST

### Endpoint
`/v2.0/admin/webhook-subscriptions`

### Parameters
#### Request Body
- **topic** (string) - Required - The event topic to subscribe to. Available topics: `customer.joined.paid_tier`, `customer.joined.free_tier`, `customer.joined.free_trial`, `customer.joined.lifetime_tier`, `customer.changed_tier`, `customer.ordered`, `customer.payment_succeeded`, `customer.payment_failed`, `customer_billing.attempt.failed`, `customer.credits.updated`, `customer.credits.expired`, `customer.cancelled`, `customer.pending_cancellation`, `customer.updated`, `customer.payment_methods.updated`.
- **callbackUrl** (string) - Required - The URL where webhook events will be sent.
- **name** (string) - Optional - A descriptive name for the webhook subscription.

### Request Example
```bash
curl -X POST "https://public.inveterateapi.com/v2.0/admin/webhook-subscriptions" \
  -H "X-Inveterate-Api-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ 
    "topic": "customer.joined.paid_tier", 
    "callbackUrl": "https://example.com/webhooks/customer-joined", 
    "name": "Customer Joined Webhook"
  }'
```

### Response
#### Success Response (201)
- **message** (string) - Confirmation message.
- **data** (object) - Details of the created webhook subscription.
  - **id** (string) - Unique identifier for the subscription.
  - **topic** (string) - The event topic the webhook subscribes to.
  - **callbackUrl** (string) - The URL to send webhook events to.
  - **name** (string) - Name of the webhook subscription.
  - **token** (string) - A secret token for verifying webhook requests (if generated).
  - **createdAt** (string) - Timestamp when the subscription was created.

#### Response Example
```json
{
  "message": "Webhook subscription created successfully",
  "data": {
    "id": "webhook_789",
    "topic": "customer.joined.paid_tier",
    "callbackUrl": "https://example.com/webhooks/customer-joined",
    "name": "Customer Joined Webhook",
    "token": "whsec_abc123xyz789",
    "createdAt": "2024-10-07T14:45:00.000Z"
  }
}
```
```

```APIDOC
## PUT /v2.0/admin/webhook-subscriptions

### Description
Modify an existing webhook subscription's callback URL or name.

### Method
PUT

### Endpoint
`/v2.0/admin/webhook-subscriptions`

### Parameters
#### Request Body
- **id** (string) - Required - The ID of the webhook subscription to update.
- **topic** (string) - Required - The event topic the webhook subscribes to.
- **callbackUrl** (string) - Required - The new URL to send webhook events to.
- **name** (string) - Optional - The new descriptive name for the webhook subscription.

### Request Example
```bash
curl -X PUT "https://public.inveterateapi.com/v2.0/admin/webhook-subscriptions" \
  -H "X-Inveterate-Api-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ 
    "id": "webhook_789", 
    "topic": "customer.joined.paid_tier", 
    "callbackUrl": "https://example.com/webhooks/v2/customer-joined", 
    "name": "Customer Joined Webhook (Updated)"
  }'
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Details of the updated webhook subscription.
  - **id** (string) - Unique identifier for the subscription.
  - **topic** (string) - The event topic the webhook subscribes to.
  - **callbackUrl** (string) - The updated URL to send webhook events to.
  - **name** (string) - The updated name of the webhook subscription.
  - **updatedAt** (string) - Timestamp when the subscription was last updated.

#### Response Example
```json
{
  "message": "Webhook subscription updated successfully",
  "data": {
    "id": "webhook_789",
    "topic": "customer.joined.paid_tier",
    "callbackUrl": "https://example.com/webhooks/v2/customer-joined",
    "name": "Customer Joined Webhook (Updated)",
    "updatedAt": "2024-10-07T15:00:00.000Z"
  }
}
```
```

--------------------------------

### Standard Error Response Formats - Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Demonstrates the standard error response formats returned by the API for various error conditions. Includes examples for bad requests (400), internal server errors (500), and unauthorized access (401), each with a specific error code and detailed message.

```bash
# 400 Bad Request - Malformed request
{
  "message": "Invalid request parameters",
  "data": {
    "error": "VALIDATION_ERROR",
    "details": {
      "field": "customerId",
      "issue": "Customer ID must be a string"
    }
  }
}

# 500 Internal Server Error - Backend error
{
  "message": "Failed to process request",
  "data": {
    "error": "BACKEND_ERROR",
    "details": "Unable to connect to billing service"
  }
}

# 401 Unauthorized - Invalid API key
{
  "message": "Invalid API key",
  "data": {
    "error": "UNAUTHORIZED",
    "details": "X-Inveterate-Api-Key header is missing or invalid"
  }
}
```

--------------------------------

### Get All Tiers - Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Retrieves all membership tiers configured for the merchant. This endpoint only works for merchants with tiers enabled. Requires an API key.

```bash
curl -X GET "https://public.inveterateapi.com/v2.0/admin/tiers" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

--------------------------------

### Retrieve All Webhook Subscriptions - Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Fetches a list of all webhook subscriptions configured for the merchant account. This GET request requires an API key for authentication and returns an array of subscription objects, each containing details like ID, topic, callback URL, and timestamps.

```bash
curl -X GET "https://public.inveterateapi.com/v2.0/admin/webhook-subscriptions" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

--------------------------------

### Get Member Credit History - Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Retrieves the complete credit transaction history for a member with pagination support. Returns all earned and redeemed credits. Supports fetching subsequent pages using the `lastCreditEntry` parameter. Requires an API key.

```bash
# Get first page of credit history
curl -X GET "https://public.inveterateapi.com/v2.0/admin/members/7733560541315/credits?limit=25" \
  -H "X-Inveterate-Api-Key: your_api_key_here"

# Get next page using encoded lastCreditEntry
curl -X GET "https://public.inveterateapi.com/v2.0/admin/members/7733560541315/credits?limit=25&lastCreditEntry=credit_def456" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

--------------------------------

### Webhook: customer.joined.free_trial

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin

Triggered when a customer joins a free trial tier in the loyalty program.

```APIDOC
## Webhook: customer.joined.free_trial

### Description
Triggered when a customer joins a free trial tier in the loyalty program.

### Method
POST

### Endpoint
/admin/webhooks/topics/customer.joined.free_trial
```

--------------------------------

### Signup Store Credits Schema

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/schemas

Defines the configuration for awarding credits upon a member's sign-up.

```APIDOC
## SignupStoreCreditsDto

### Description
Configuration for awarding credits upon sign-up.

### Parameters
#### Request Body
- **creditAmount** (number) - Required - The amount to be awarded upon sign-up.
- **name** (string) - Required - The name (appearance only) of this benefit.
- **days** (number) - Required - The number of days to delay the credit award.
- **description** (string) - Required - The description of this benefit (appearance only).
- **type** (string) - Required - This is an internal identifier, leave default.
```

--------------------------------

### Admin vs Storefront Endpoints

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/index

Understanding the difference between Admin and Storefront endpoints and their authentication methods.

```APIDOC
## Admin vs Storefront

As of now, admin and storefront methods operate in the same way--use the same API key in the header to authenticate both kinds of endpoints. The admin endpoints were created to model after admin actions within the merchant dashboard, while the storefront was made to model data that members are allowed to access.

In the (near) future, storefront endpoints will have their own "storefront" authentication through Shopify using a member's credentials. This will allow you to build authenticated apps and services outside of the Inveterate/Shopify ecosystem.

**The storefront endpoints will always support authentication via the `X-Inveterate-Api-Key`, however.**
```

--------------------------------

### GET /v2.0/admin/benefits/{type}

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/benefits

Retrieves a specific benefit by its type.

```APIDOC
## GET /v2.0/admin/benefits/{type}

### Description
Retrieves a specific benefit by its type.

### Method
GET

### Endpoint
/v2.0/admin/benefits/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - The type of benefit to retrieve.

### Request Example
```json
{
  "type": "health"
}
```

### Response
#### Success Response (200)
- **benefit** (object) - The benefit object.
  - **id** (integer) - The unique identifier of the benefit.
  - **type** (string) - The type of benefit.
  - **description** (string) - A description of the benefit.

#### Response Example
```json
{
  "benefit": {
    "id": 1,
    "type": "health",
    "description": "Comprehensive health insurance."
  }
}
```
```

--------------------------------

### GET /v2.0/admin/tiers/{id}

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/tiers

Retrieves a specific tier by its ID.

```APIDOC
## GET /v2.0/admin/tiers/{id}

### Description
Retrieves a specific tier by its unique identifier.

### Method
GET

### Endpoint
/v2.0/admin/tiers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tier to retrieve.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the tier.
- **name** (string) - The name of the tier.
- **description** (string) - A description of the tier.
- **created_at** (string) - The timestamp when the tier was created.
- **updated_at** (string) - The timestamp when the tier was last updated.

#### Response Example
```json
{
  "example": "{\"id\": \"tier_1\", \"name\": \"Basic Tier\", \"description\": \"Entry-level tier with basic features.\", \"created_at\": \"2023-10-27T10:00:00Z\", \"updated_at\": \"2023-10-27T10:00:00Z\" }"
}
```
```

--------------------------------

### GET /v2.0/storefront/benefits/{id}

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/storefront/benefits

Retrieves details for a specific benefit by its ID.

```APIDOC
## GET /v2.0/storefront/benefits/{id}

### Description
Retrieves details for a specific benefit by its ID.

### Method
GET

### Endpoint
/v2.0/storefront/benefits/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the benefit to retrieve.

### Request Example
```json
{
  "example": "GET /v2.0/storefront/benefits/benefit_123"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the benefit.
- **name** (string) - The name of the benefit.
- **description** (string) - A detailed description of the benefit.

#### Response Example
```json
{
  "example": "{\"id\":\"benefit_123\",\"name\":\"Health Insurance\",\"description\":\"Comprehensive health coverage.\" }"
}
```
```

--------------------------------

### Create Webhook Subscription - Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Creates a new webhook subscription to receive real-time notifications for specified events. This POST request requires an API key, a JSON payload with `topic`, `callbackUrl`, and `name`. The response includes the newly created subscription's details, including its ID and a secret token.

```bash
curl -X POST "https://public.inveterateapi.com/v2.0/admin/webhook-subscriptions" \
  -H "X-Inveterate-Api-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "customer.joined.paid_tier",
    "callbackUrl": "https://example.com/webhooks/customer-joined",
    "name": "Customer Joined Webhook"
  }'
```

--------------------------------

### GET /v2.0/admin/tiers/{id}/benefits

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/tiers/benefits

Retrieves a list of all benefits associated with a specific tier.

```APIDOC
## GET /v2.0/admin/tiers/{id}/benefits

### Description
Retrieves a list of all benefits associated with a specific tier.

### Method
GET

### Endpoint
/v2.0/admin/tiers/{id}/benefits

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the tier to retrieve benefits for.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **benefits** (array) - A list of benefit objects.
  - **type** (string) - The type of the benefit.
  - **details** (string) - A description of the benefit.

#### Response Example
```json
{
  "benefits": [
    {
      "type": "free_shipping",
      "details": "Free shipping on all orders."
    },
    {
      "type": "priority_support",
      "details": "24/7 priority customer support."
    }
  ]
}
```
```

--------------------------------

### Get Member by ID (OpenAPI 3.0.0)

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/storefront/members

This snippet defines the OpenAPI 3.0.0 schema for retrieving a member's data by their ID. It specifies the request method (GET), path parameters (member ID), header parameters (API key), and possible responses (200, 400, 500) with their associated schemas.

```json
{"openapi":"3.0.0","info":{"title":"Inveterate Public API","version":"v2.0"},"paths":{"/v2.0/storefront/members/{id}":{"get":{"operationId":"MembersController_findOne","summary":"","description":"Returns all member data for a given member that is a part of your store. Merchant is pulled from the public API key for security reasons. Make sure to include the customer ID in the request path.","parameters":[{"name":"X-Inveterate-Api-Key","in":"header","description":"Your private Inveterate API key.","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"The customer ID number.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned upon successful direct action to our database. Action is immediate.","schema":{"allOf":[{"$ref":"#/components/schemas/ResponseBodyDto"}]}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBodyDto"}}}},"400":{"description":"Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.","schema":{"allOf":[{"$ref":"#/components/schemas/ResponseBodyDto"}]}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBodyDto"}}}},"500":{"description":"Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.","schema":{"allOf":[{"$ref":"#/components/schemas/ResponseBodyDto"}]}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBodyDto"}}}}},"tags":["Storefront - Members"]}}},"components":{"schemas":{"ResponseBodyDto":{"type":"object","properties":{"message":{"type":"string","description":"The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error."},"data":{"type":"object","description":"The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error."}},"required":["message","data"]}}}}
```

--------------------------------

### Authenticate API Requests using Bash

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Demonstrates how to authenticate API requests using a cURL command with the `X-Inveterate-Api-Key` header. This is essential for identifying the merchant and securing operations.

```bash
# Get merchant data (health check)
curl -X GET "https://public.inveterateapi.com/v2.0/admin/merchant" \
  -H "X-Inveterate-Api-Key: your_api_key_here"

# Example successful response
{
  "message": "Merchant data retrieved successfully",
  "data": {
    "merchantId": "merchant_12345",
    "shopDomain": "example.myshopify.com",
    "tiersEnabled": true,
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
```

--------------------------------

### GET /v2.0/admin/tiers/{id}/benefits/{type}

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/tiers/benefits

Retrieves a specific benefit by its type for a given tier.

```APIDOC
## GET /v2.0/admin/tiers/{id}/benefits/{type}

### Description
Retrieves a specific benefit by its type for a given tier.

### Method
GET

### Endpoint
/v2.0/admin/tiers/{id}/benefits/{type}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the tier.
- **type** (string) - Required - The type of the benefit to retrieve.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **benefit** (object)
  - **type** (string) - The type of the benefit.
  - **details** (string) - A description of the benefit.

#### Response Example
```json
{
  "benefit": {
    "type": "free_shipping",
    "details": "Free shipping on all orders."
  }
}
```
```

--------------------------------

### Member Creation Schema

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/schemas

Defines the structure for creating a new member, including personal details, account state, and transactional information.

```APIDOC
## CreateMemberDto

### Description
Schema for creating a new member.

### Parameters
#### Request Body
- **merchantId** (string) - Required - The ID of the merchant.
- **customerId** (string) - Required - The ID of the customer.
- **accountState** (string) - Required - The current state of the member's account.
- **anonymized** (boolean) - Required - Whether the member's data is anonymized.
- **contractId** (number) - Required - The ID of the associated contract.
- **createdAt** (string) - Required - The timestamp when the member was created.
- **credit** (number) - Required - The current credit balance of the member.
- **creditsEarned** (number) - Required - The total credits earned by the member.
- **email** (string) - Required - The email address of the member.
- **firstName** (string) - Required - The first name of the member.
- **joinedAt** (string) - Required - The timestamp when the member joined.
- **lastCreditRedemptionAt** (string) - Required - The timestamp of the last credit redemption.
- **lastName** (string) - Required - The last name of the member.
- **lastPurchaseAt** (string) - Required - The timestamp of the last purchase.
- **notes** (string) - Required - Internal notes for the member.
- **numberOfCreditRedemptions** (number) - Required - The total number of credit redemptions.
- **orderCount** (number) - Required - The total number of orders placed by the member.
- **orderIds** (array of numbers) - Required - A list of order IDs associated with the member.
- **paymentId** (number) - Required - The ID of the associated payment.
- **phoneNumber** (string) - Required - The phone number of the member.
- **referrals** (number) - Required - The number of referrals made by the member.
- **referredBy** (number) - Required - The ID of the member who referred this member.
- **revenue** (number) - Required - The total revenue generated by this member.
- **status** (string) - Required - The status of the member.
- **totalSpend** (number) - Required - The total amount spent by the member.
- **updatedAt** (string) - Required - The timestamp when the member was last updated.
```

--------------------------------

### Admin Credits

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin

Endpoints for retrieving and creating credit requests for members.

```APIDOC
## Admin Credits

### Description
Get and create credit requests.

### Method
GET, POST

### Endpoint
/admin/members/credits
```

--------------------------------

### GET /v2.0/admin/webhook-subscriptions

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin/webhooks/overview

Retrieves all webhook subscriptions associated with the merchant.

```APIDOC
## GET /v2.0/admin/webhook-subscriptions

### Description
Returns all webhook subscriptions for the merchant.

### Method
GET

### Endpoint
/v2.0/admin/webhook-subscriptions

### Parameters
#### Header Parameters
- **X-Inveterate-Api-Key** (string) - Required - Your private Inveterate API key.

### Request Example
```json
{
  "X-Inveterate-Api-Key": "YOUR_API_KEY"
}
```

### Response
#### Success Response (200)
- **message** (string) - The message associated with the response. Generally, the message only confirms the requested action.
- **data** (object) - The data associated with the response.

#### Error Response (400)
- **message** (string) - The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.
- **data** (object) - The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

#### Error Response (500)
- **message** (string) - The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.
- **data** (object) - The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

#### Response Example (Success)
```json
{
  "message": "Webhook subscriptions retrieved successfully.",
  "data": [
    {
      "id": "sub_123",
      "url": "https://example.com/webhook",
      "event_type": "order.created"
    }
  ]
}
```

#### Response Example (Error)
```json
{
  "message": "Malformed request. Check your API key, URL parameters, and body parameters.",
  "data": {}
}
```
```

--------------------------------

### Admin Webhooks

Source: https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/admin

Endpoints for managing webhook subscriptions.

```APIDOC
## Admin Webhooks

### Description
Manage webhook subscriptions. Use these to build third-party integrations.

### Method
GET, POST, PUT, DELETE

### Endpoint
/admin/webhooks
```

--------------------------------

### Get Single Tier

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Retrieve detailed information about a specific tier including all associated benefits and campaigns.

```APIDOC
## GET /v2.0/admin/tiers/{tierId}

### Description
Retrieve detailed information about a specific tier including all associated benefits and campaigns.

### Method
GET

### Endpoint
`/v2.0/admin/tiers/{tierId}`

### Parameters
#### Path Parameters
- **tierId** (string) - Required - The ID of the tier to retrieve.

### Request Example
```bash
curl -X GET "https://public.inveterateapi.com/v2.0/admin/tiers/premium_tier_abc123" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Tier details.
  - **id** (string) - Unique identifier for the tier.
  - **name** (string) - Name of the tier.
  - **type** (string) - Type of the tier (e.g., FREE, PAID).
  - **price** (number) - Price of the tier (if applicable).
  - **currency** (string) - Currency of the price (if applicable).
  - **billingInterval** (string) - Billing interval for paid tiers (e.g., MONTHLY).
  - **description** (string) - Description of the tier.
  - **memberCount** (integer) - Number of members in the tier.
  - **spendThreshold** (any) - Threshold for spending to qualify for the tier (if applicable).
  - **benefits** (array) - List of benefits associated with the tier.
    - **id** (string) - Unique identifier for the benefit.
    - **type** (string) - Type of the benefit.
    - **name** (string) - Name of the benefit.
    - **enabled** (boolean) - Whether the benefit is enabled.
    - **configuration** (object) - Configuration details for the benefit.
  - **campaigns** (array) - List of campaigns associated with the tier.

#### Response Example
```json
{
  "message": "Tier retrieved successfully",
  "data": {
    "id": "premium_tier_abc123",
    "name": "Gold",
    "type": "PAID",
    "price": 9.99,
    "currency": "USD",
    "billingInterval": "MONTHLY",
    "description": "Premium membership with exclusive benefits",
    "memberCount": 350,
    "spendThreshold": null,
    "benefits": [
      {
        "id": "benefit_001",
        "type": "FREE_SHIPPING",
        "name": "Free Standard Shipping",
        "enabled": true,
        "configuration": {
          "minimumSubtotal": 0,
          "excludedCountries": []
        }
      },
      {
        "id": "benefit_002",
        "type": "RECURRING_CREDITS",
        "name": "Monthly Credit Award",
        "enabled": true,
        "configuration": {
          "creditAmount": 50,
          "frequency": 30
        }
      }
    ],
    "campaigns": []
  }
}
```
```

--------------------------------

### GET /admin/tiers

Source: https://context7.com/context7/help_inveterate_dev_api-reference-docs_public-api-2_0-reference/llms.txt

Retrieves a list of all membership tiers configured for the merchant. This endpoint is only accessible for merchants who have tiers enabled.

```APIDOC
## Get All Tiers

### Description
Retrieve all membership tiers configured for the merchant. This endpoint only works for merchants with tiers enabled.

### Method
GET

### Endpoint
`/admin/tiers`

### Query Parameters
None

### Request Example
```bash
curl -X GET "https://public.inveterateapi.com/v2.0/admin/tiers" \
  -H "X-Inveterate-Api-Key: your_api_key_here"
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (array) - An array of tier objects.
  - **tierId** (string) - The unique identifier for the tier.
  - **name** (string) - The name of the tier.
  - **description** (string) - A description of the tier.
  - **isPaid** (boolean) - Indicates if the tier is a paid tier.
  - **benefits** (array) - A list of benefits associated with the tier.

#### Response Example
```json
{
  "message": "Tiers retrieved successfully",
  "data": [
    {
      "tierId": "basic_tier_xyz456",
      "name": "Basic Tier",
      "description": "Standard benefits for new members.",
      "isPaid": false,
      "benefits": ["Early access to sales"]
    },
    {
      "tierId": "premium_tier_abc123",
      "name": "Premium Tier",
      "description": "Enhanced benefits for loyal customers.",
      "isPaid": true,
      "benefits": ["Exclusive discounts", "Priority support"]
    }
  ]
}
```
```
Tokens:
Raw