Management API Specification

v1.0.0

API

Download OpenAPI Document

Servers

https://api2.sesamy.comCurrent environment

Vendors

Operations

GET/management/vendors POST/management/vendors

List the vendors the user can administrate

GET

/management/vendors

Get the vendors the authenticated user has publisher permissions for, based on their organization memberships.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Responses

The vendors the user has publisher permissions for

Content-Type

application/json

JSON

[

{

"name": "string",

"id": "string",

"logo": "string"

}

]

GET

/management/vendors

Playground

Authorization

OpenID

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

POST /management/vendors

POST

/management/vendors

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Request Body

application/json

JSON

{

"name": "string",

"id": "string",

"website": "string",

"country": "string"

}

Responses

Status

POST

/management/vendors

Playground

Authorization

OpenID

Body

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

Bills

Operations

GET/management/bills GET/management/bills/{id}

Contracts

Operations

GET/management/contracts GET/management/contracts/{id}GET/management/contracts/{id}/licenses GET/management/contracts/{id}/upgrade-options

Transactions

Operations

GET/management/transactions

Products

Operations

GET/management/products POST/management/products GET/management/products/{sku}PATCH/management/products/{sku}GET/management/products/{sku}/fulfillments

Users

Operations

GET/management/users POST/management/users GET/management/users/{user_id}DELETE/management/users/{user_id}PATCH/management/users/{user_id}POST/management/users/{user_id}/change-login-identifier POST/management/users/{user_id}/add-phone-identifier PUT/management/users/{user_id}/user_metadata/{key}DELETE/management/users/{user_id}/user_metadata/{key}POST/management/users/{user_id}/set-password

Team

Operations

GET/management/team POST/management/team PUT/management/team/{userId}DELETE/management/team/{userId}

Compatibility

Operations

GET/management/mc/customers/{customerId}

Get customer information

GET

/management/mc/customers/{customerId}

Returns customer information in XML format for Mediaconnect compatibility.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Basic

TypeHTTP (basic)

Parameters

Path Parameters

customerId*

The unique identifier of the customer

Typestring

Required

Example"958280"

Responses

Customer information in XML format

Content-Type

application/xml

XML

GET

/management/mc/customers/{customerId}

Playground

Authorization

OpenID

Basic

Variables

Key

Value

customerId*

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

Entitlements

Operations

GET/management/entitlements

Checkouts

Operations

GET/management/checkouts/{id}

Get a checkout by id

GET

/management/checkouts/{id}

Fetches a single checkout belonging to the caller's vendor. Primarily used to hydrate a checkout.1#confirm webhook event, which carries only a checkoutId.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

id*

The unique identifier of the checkout

Typestring

Required

Example"checkout123"

Responses

The checkout

Content-Type

application/json

JSON

{

"items": [

{

"sku": "string",

"url": "string",

"purchaseOptionId": "string",

"price": 0,

"currency": "string",

"geoRestrictions": {

"countries": [

"string"

"type": "string"

}

"address": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

"businessAddress": {

"country": "string",

"zip": "string",

"city": "string",

"street": "string",

"co": "string",

"lastName": "string",

"firstName": "string"

"email": "string",

"givenName": "string",

"familyName": "string",

"birthDate": "string",

"phoneNumber": "string",

"country": "string",

"referralEmail": "string",

"language": "string",

"redirectUrl": "string",

"isBusiness": true,

"price": 0,

"currency": "string",

"anonymousUserId": "string",

"attribution": {

"utmSource": "string",

"utmMedium": "string",

"utmCampaign": "string",

"utmTerm": "string",

"utmContent": "string",

"source": "string",

"sourceId": "string",

"itemSrc": "string",

"publisherContentId": "string",

"_ga": "string",

"_gid": "string",

"_fbp": "string",

"_fbc": "string",

"gaSessionId": "string"

"paymentData": {

"provider": "string",

"method": "string"

"paymentMethodsFilter": [

{

"provider": "string",

"methods": [

"string"

]

}

"fieldSettings": {

"name": {

"enabled": true,

"required": true

"phone": {

"enabled": true,

"required": true

"birthdate": {

"enabled": true,

"required": true

"referral": {

"enabled": true

}

"giftMode": true,

"requireAddress": true,

"metadata": {

"additionalProperties": "string"

"id": "string",

"checkoutUrl": "string",

"status": "string",

"type": "string",

"itemsOwned": [

{

"sku": "string",

"purchaseOptionId": "string",

"title": "string"

}

"appliedDiscountCodes": [

{

"name": "string",

"id": "string",

"code": "string",

"description": "string",

"status": "string"

}

"availablePaymentMethods": [

{

"provider": "string",

"methods": [

"string"

]

}

"payer": {

"id": "string",

"email": "string"

"createdAt": "string",

"updatedAt": "string"

}

Paywalls

Operations

GET/management/paywalls GET/management/paywalls/{paywallId}

List paywalls

GET

/management/paywalls

Lists all paywalls configured for the authenticated vendor.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Responses

The list of paywalls for the vendor

Content-Type

application/json

JSON

[

{

"id": "aM8o7LqpkGZJ-szyPwe_E",

"vendorId": "24victoria",

"currency": "DKK",

"version": 2,

"name": "Article paywall",

"entity": "Paywall",

"status": "ACTIVE",

"createdAt": "2026-01-01T00:00:00.000Z",

"modifiedAt": "2026-01-01T00:00:00.000Z",

"previewUrl": "https://api.sesamy.com/paywall/paywalls/vendor/abc/preview",

"settings": {

"template": "BOXES",

"useDefaultLogo": true,

"useDefaultCurrency": true,

"useDefaultColor": true,

"styling": {

"dropShadow": true,

"backgroundColor": "#000000",

"showBackground": false

"displayOptions": {

"enableGift": true,

"enableCompany": true,

"enableLoginButton": true

"leaky": {

"enabled": true,

"count": 3,

"periodInHours": 720

}

"showLoginButton": true,

"subscriptions": [

{

"id": "R4gX0YSbSU1WJA7bCrbQw",

"sku": "sid:fGb4GbMUclADQtBxoX1rl",

"poId": "VDuH_poxqIPKW638Ok43q",

"title": "Månedsabonnement",

"description": "<p>Kun 720 kr./år – spar 20%</p>",

"price": 99,

"discountPrice": 75,

"discountCode": "",

"periodText": "måned",

"tag": "",

"selected": true,

"features": [

[

"Daglige nyheder om tech, startups og scaleups",

"Eksklusive interviews med founders"

]

"buttonText": "KØB ADGANG",

"readMoreText": "Læs mere",

"preferBusiness": false,

"url": "https://24victoria.dk/business"

}

"features": [

[

"Danmarks nyhedsmedie om techvirksomeder. startups & scaleups"

]

"mainColor": "#3377fe",

"headline": "Login for at læse artiklen",

"logoUrl": "https://assets.sesamy.com/vendor-assets/24victoria/ad29ee3a-4648-453e-92ad-a2d43c68cd39.svg",

"footerPaymentMethods": [

[

"visa",

"mastercard",

"google-pay",

"apple-pay"

]

"singlePurchase": {

"enabled": true,

"title": "Buy Now",

"description": "One-time purchase",

"discountCode": ""

}

]

GET

/management/paywalls

Playground

Authorization

OpenID

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

Get paywall by ID

GET

/management/paywalls/{paywallId}

Retrieves the paywall configuration and settings for the specified paywall ID.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Path Parameters

paywallId*

Typestring

Required

Example"pw123456"

Responses

The paywall information and configuration

Content-Type

application/json

JSON

{

"id": "aM8o7LqpkGZJ-szyPwe_E",

"vendorId": "24victoria",

"currency": "DKK",

"version": 2,

"name": "Article paywall",

"entity": "Paywall",

"status": "ACTIVE",

"createdAt": "2026-01-01T00:00:00.000Z",

"modifiedAt": "2026-01-01T00:00:00.000Z",

"previewUrl": "https://api.sesamy.com/paywall/paywalls/vendor/abc/preview",

"settings": {

"template": "BOXES",

"useDefaultLogo": true,

"useDefaultCurrency": true,

"useDefaultColor": true,

"styling": {

"dropShadow": true,

"backgroundColor": "#000000",

"showBackground": false

"displayOptions": {

"enableGift": true,

"enableCompany": true,

"enableLoginButton": true

"leaky": {

"enabled": true,

"count": 3,

"periodInHours": 720

}

"showLoginButton": true,

"subscriptions": [

{

"id": "R4gX0YSbSU1WJA7bCrbQw",

"sku": "sid:fGb4GbMUclADQtBxoX1rl",

"poId": "VDuH_poxqIPKW638Ok43q",

"title": "Månedsabonnement",

"description": "<p>Kun 720 kr./år – spar 20%</p>",

"price": 99,

"discountPrice": 75,

"discountCode": "",

"periodText": "måned",

"tag": "",

"selected": true,

"features": [

[

"Daglige nyheder om tech, startups og scaleups",

"Eksklusive interviews med founders"

]

"buttonText": "KØB ADGANG",

"readMoreText": "Læs mere",

"preferBusiness": false,

"url": "https://24victoria.dk/business"

}

"features": [

[

"Danmarks nyhedsmedie om techvirksomeder. startups & scaleups"

]

"mainColor": "#3377fe",

"headline": "Login for at læse artiklen",

"logoUrl": "https://assets.sesamy.com/vendor-assets/24victoria/ad29ee3a-4648-453e-92ad-a2d43c68cd39.svg",

"footerPaymentMethods": [

[

"visa",

"mastercard",

"google-pay",

"apple-pay"

]

"singlePurchase": {

"enabled": true,

"title": "Buy Now",

"description": "One-time purchase",

"discountCode": ""

}

GET

/management/paywalls/{paywallId}

Playground

Authorization

OpenID

Variables

Key

Value

paywallId*

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

Access-Lists

Operations

GET/management/access-lists POST/management/access-lists GET/management/access-lists/{id}PUT/management/access-lists/{id}PATCH/management/access-lists/{id}

Grants

Operations

GET/management/access-lists/{id}/grants POST/management/access-lists/{id}/grants GET/management/access-lists/{id}/grants/{grantId}PUT/management/access-lists/{id}/grants/{grantId}DELETE/management/access-lists/{id}/grants/{grantId}

Sites

Operations

GET/management/sites GET/management/sites/{domain}PUT/management/sites/{domain}

diagnostics

Operations

GET/management/diagnostics/{identifier}DELETE/management/diagnostics/{identifier}

Stats

Operations

GET/management/stats/revenue

GET /management/stats/revenue

GET

/management/stats/revenue

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Parameters

Query Parameters

metric*

Typestring

Required

Valid values

"currentMrr""newMrr""churnMrr""projectedMrr""totalRevenue""totalSales""subscriptionSales"

Example"currentMrr"

fromDate*

Typestring

Required

Example"2026-01-01"

Format"date"

toDate*

Typestring

Required

Example"2026-03-31"

Format"date"

Responses

A summarised revenue metric for the vendor

Content-Type

application/json

JSON

{

"vendorId": "string",

"metric": "string",

"fromDate": "string",

"toDate": "string",

"title": "string",

"description": "string",

"headline": {

"value": 0,

"unit": "string"

"series": [

{

"id": "string",

"first": 0,

"last": 0,

"points": 0

}

]

}

Create a signed link for content access

POST

/management/create-signed-link

Creates a signed token that grants access to encrypted content. Optionally appends it to a URL. Use for share links, email campaigns, gift access, or temporary tier access.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Request Body

application/json

JSON

{

"url": "https://example.com/article/123",

"sku": "premium-subscription",

"purchaseOption": "monthly",

"publisherContentId": "article-2024-01-15-news",

"userId": "user-456",

"maxUses": 1000,

"expiresIn": "7d",

"meta": {

"additionalProperties": "string"

}

Responses

The signed link/token

Content-Type

application/json

JSON

{

"signedUrl": "string",

"token": "string",

"tokenId": "string",

"expiresAt": "string",

"sku": "string",

"publisherContentId": "string"

}

POST

/management/create-signed-link

Playground

Authorization

OpenID

Body

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

Domains

Operations

GET/management/domains GET/management/domains/{domain}PUT/management/domains/{domain}DELETE/management/domains/{domain}

Sync (temporary)

Operations

POST/management/sync/team-to-organization

Migrate a vendor's portal team members into its authhero organization

POST

/management/sync/team-to-organization

Temporary endpoint for one-off migration. Reads portal team members from the legacy backend, ensures an organization exists on the sesamy authhero tenant, and adds each member with their mapped role.

Authorizations

OpenID

TypeOpenID Connect (https://token.sesamy.com/.well-known/openid-configuration)

Request Body

application/json

JSON

{

"vendor_id": "breakit",

"dry_run": false

}

Responses

Sync result

Content-Type

application/json

JSON

{

"vendorId": "string",

"dryRun": true,

"orgCreated": true,

"membersFound": 0,

"added": 0,

"missing": 0,

"failed": 0,

"results": [

{

"email": "string",

"userId": "string",

"roles": [

"string"

"status": "string",

"error": "string"

}

]

}

POST

/management/sync/team-to-organization

Playground

Authorization

OpenID

Body

Samples

cURLJavaScriptPHPPython

cURL

JavaScript

PHP

Python

Management API Specification ​

API​

Servers​

Vendors​

Operations​

List the vendors the user can administrate​

Authorizations​

Responses​

Playground​

Samples​

POST /management/vendors​

Authorizations​

Request Body​

Responses​

Playground​

Samples​

Bills​

Operations​

GET /management/bills​

Authorizations​

Parameters​

Query Parameters

Responses​

Playground​

Samples​

GET /management/bills/{id}​

Authorizations​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

Contracts​

Operations​

GET /management/contracts​

Authorizations​

Parameters​

Query Parameters

Responses​

Playground​

Samples​

GET /management/contracts/{id}​

Authorizations​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

GET /management/contracts/{id}/licenses​

Authorizations​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

List upgrade options​

Authorizations​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

Transactions​

Operations​

GET /management/transactions​

Authorizations​

Parameters​

Query Parameters

Responses​

Playground​

Samples​

Products​

Operations​

GET /management/products​

Authorizations​

Parameters​

Query Parameters

Responses​

Playground​

Samples​

Management API Specification

API

Servers

Vendors

Operations

List the vendors the user can administrate

Authorizations

Responses

Playground

Samples

POST /management/vendors

Authorizations

Request Body

Responses

Playground

Samples

Bills

Operations

GET /management/bills

Authorizations

Parameters

Responses

Playground

Samples

GET /management/bills/{id}

Authorizations

Parameters

Responses

Playground

Samples

Contracts

Operations

GET /management/contracts

Authorizations

Parameters

Responses

Playground

Samples

GET /management/contracts/{id}

Authorizations

Parameters

Responses

Playground

Samples

GET /management/contracts/{id}/licenses

Authorizations

Parameters

Responses

Playground

Samples

List upgrade options

Authorizations

Parameters

Responses

Playground

Samples

Transactions

Operations

GET /management/transactions

Authorizations

Parameters

Responses

Playground

Samples

Products

Operations

GET /management/products

Authorizations

Parameters

Responses

Playground

Samples

POST /management/products

Authorizations

Request Body

Responses

Playground

Samples

GET /management/products/{sku}

Authorizations