newsletter API reference — Part 7

Embed

<a href="https://hermeticor.com/docs/ref-newsletter"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/6ddb6b60-e4af-4ab8-9e30-d59475817fd4/social-card.svg?v=3e7ae33eec8b" alt="newsletter" width="600" height="315"></a>

PATCHhttps://hermeticor.com/v1/newsletter/tiers/{id}

Edit a tier. Price changes apply to new subscribers only.

Parameters

idstringpathrequired

Request body

application/json

namestring

descriptionstring

benefitsstring[]

currencystring

monthlyMinorinteger

annualMinorinteger

trialDaysinteger

isFoundingboolean

foundingLimitinteger

teamPlanboolean

positioninteger

{
  "name": "string",
  "description": "string",
  "benefits": [
    "string"
  ],
  "currency": "string",
  "monthlyMinor": 0,
  "annualMinor": 0,
  "trialDays": 0,
  "isFounding": true,
  "foundingLimit": 0,
  "teamPlan": true,
  "position": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/newsletter/tiers/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","benefits":["string"],"currency":"string","monthlyMinor":0,"annualMinor":0,"trialDays":0,"isFounding":true,"foundingLimit":0,"teamPlan":true,"position":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "description": "string",
  "benefits": [
    "string"
  ],
  "currency": "string",
  "monthlyMinor": 0,
  "annualMinor": 0,
  "trialDays": 0,
  "isFounding": true,
  "foundingLimit": 0,
  "teamPlan": true,
  "status": "active",
  "position": 0,
  "members": 0
}

Schema

idstringrequired

namestringrequired

descriptionstringrequired

benefitsstring[]required

currencystringrequired

monthlyMinorintegerrequired

annualMinorintegerrequired

trialDaysintegerrequired

isFoundingbooleanrequired

foundingLimitintegerrequired

teamPlanbooleanrequired

statusstringrequired

active | archived

positionintegerrequired

membersinteger

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

POSThttps://hermeticor.com/v1/newsletter/tiers/{id}/archive

Archive a tier: current members keep it, nobody new can join

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/tiers/{id}/archive" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/newsletter/tiers/{id}

4XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

GEThttps://hermeticor.com/v1/newsletter/coupons

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/coupons" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "code": "string",
      "percentOff": 0,
      "amountOffMinor": 0,
      "currency": "string",
      "duration": "string",
      "durationMonths": 0,
      "maxRedemptions": 0,
      "redeemed": 0,
      "expiresAt": "2024-01-01T00:00:00Z",
      "tierIds": [
        "string"
      ],
      "status": "active"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem192[]required

Show child parameters

idstringrequired

codestringrequired

percentOffnumberrequired

amountOffMinorintegerrequired

currencystringrequired

durationstringrequired

durationMonthsintegerrequired

maxRedemptionsintegerrequired

redeemedintegerrequired

expiresAtstringrequired

tierIdsstring[]required

statusstringrequired

active | archived

nextCursorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

POSThttps://hermeticor.com/v1/newsletter/coupons

Request body

application/json

codestringrequired

percentOffnumber

amountOffMinorinteger

currencystring

durationstring

once | repeating | forever = once

durationMonthsinteger

maxRedemptionsinteger

expiresAtstring

tierIdsstring[]

= []

{
  "code": "string",
  "percentOff": 0,
  "amountOffMinor": 0,
  "currency": "string",
  "duration": "once",
  "durationMonths": 0,
  "maxRedemptions": 0,
  "expiresAt": "2024-01-01T00:00:00Z",
  "tierIds": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/coupons" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","percentOff":0,"amountOffMinor":0,"currency":"string","duration":"once","durationMonths":0,"maxRedemptions":0,"expiresAt":"2024-01-01T00:00:00Z","tierIds":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "code": "string",
  "percentOff": 0,
  "amountOffMinor": 0,
  "currency": "string",
  "duration": "string",
  "durationMonths": 0,
  "maxRedemptions": 0,
  "redeemed": 0,
  "expiresAt": "2024-01-01T00:00:00Z",
  "tierIds": [
    "string"
  ],
  "status": "active"
}

Schema

idstringrequired

codestringrequired

percentOffnumberrequired

amountOffMinorintegerrequired

currencystringrequired

durationstringrequired

durationMonthsintegerrequired

maxRedemptionsintegerrequired

redeemedintegerrequired

expiresAtstringrequired

tierIdsstring[]required

statusstringrequired

active | archived

4XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

POSThttps://hermeticor.com/v1/newsletter/coupons/{id}/archive

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/coupons/{id}/archive" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/newsletter/coupons

4XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

GEThttps://hermeticor.com/v1/newsletter/gifts

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/newsletter/gifts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "tierId": "string",
      "interval": "month",
      "status": "pending_payment",
      "recipientEmail": "string",
      "buyerEmail": "string",
      "redeemUrl": "string",
      "redeemedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem193[]required

Show child parameters

idstringrequired

tierIdstringrequired

intervalstringrequired

month | year

statusstringrequired

pending_payment | paid | redeemed | expired

recipientEmailstringrequired

buyerEmailstringrequired

redeemUrlstringrequired

redeemedAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

POSThttps://hermeticor.com/v1/newsletter/gifts

Create a gift and its Stripe Checkout link for the buyer; the redeem link works once paid

Request body

application/json

buyerEmailstringrequired

recipientEmailstring

tierIdstringrequired

intervalstring

month | year = year

messagestring

successUrlstring

cancelUrlstring

{
  "buyerEmail": "string",
  "recipientEmail": "string",
  "tierId": "string",
  "interval": "year",
  "message": "string",
  "successUrl": "string",
  "cancelUrl": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/newsletter/gifts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"buyerEmail":"string","recipientEmail":"string","tierId":"string","interval":"year","message":"string","successUrl":"string","cancelUrl":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "gift": {
    "id": "string",
    "tierId": "string",
    "interval": "month",
    "status": "pending_payment",
    "recipientEmail": "string",
    "buyerEmail": "string",
    "redeemUrl": "string",
    "redeemedAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z"
  },
  "checkoutUrl": "string"
}

Schema

giftobjectrequired

Show child parameters

idstringrequired

tierIdstringrequired

intervalstringrequired

month | year

statusstringrequired

pending_payment | paid | redeemed | expired

recipientEmailstringrequired

buyerEmailstringrequired

redeemUrlstringrequired

redeemedAtstringrequired

createdAtstringrequired

checkoutUrlstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

5XX Default Response

Same as 4XX · PATCH /v1/newsletter/tiers/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?