Skip to main content
Skip to navigation
API docs by Redocly

Developer API (2.0.0)

Download OpenAPI specification:Download

Paywall Fonts & Media

Part of the REST API v2 Reference. More Paywall endpoints: Paywall, Paywall Publishing.

Operations about paywalls.

Endpoints

Get a list of fonts

This endpoint requires the following permission(s): project_configuration:offerings:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

query Parameters
starting_after
string
Example: starting_after=ent12354

Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page.

limit
integer
Default: 20
Example: limit=10

Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/fonts?starting_after=font123456789abcdef",
  • "url": "/v2/projects/proj1ab2c3d4/fonts"
}

Upload a font

This endpoint requires the following permission(s): project_configuration:offerings:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

Request Body schema: application/json
required
filename
required
string [ 1 .. 255 ] characters

File name for the uploaded font. Must have a .ttf or .otf extension.

content_type
required
string
Enum: "font/ttf" "font/otf"

MIME type for the uploaded font.

file_data_base64
required
string [ 1 .. 6990508 ] characters

Base64-encoded font bytes.

Responses

Request samples

Content type
application/json
{
  • "filename": "GoodSans-Bold.ttf",
  • "content_type": "font/ttf",
  • "file_data_base64": "AAEAAAALAIAAAwAwT1MvMg8SBfAAAAC8AAAAYGNtYXAaVsyKAAABHA"
}

Response samples

Content type
application/json
{
  • "object": "font",
  • "id": "font123456789abcdef",
  • "name": "GoodSans-Bold",
  • "family_name": "Good Sans",
  • "style": "normal",
  • "weight": 700,
  • "url": "https://fonts.revenuecat.com/1_abc123_def456.ttf",
  • "font_key": "RCFM:1_font123456789abcdef:GoodSans-Bold"
}

Get a list of media assets

This endpoint requires the following permission(s): project_configuration:offerings:read. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

query Parameters
starting_after
string
Example: starting_after=ent12354

Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page.

limit
integer
Default: 20
Example: limit=10

Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj1ab2c3d4/media_assets?starting_after=mediaasset123456789abcdef",
  • "url": "/v2/projects/proj1ab2c3d4/media_assets"
}

Upload a media asset

This endpoint requires the following permission(s): project_configuration:offerings:read_write. This endpoint belongs to the Project Configuration domain, which has a default rate limit of 60 requests per minute.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

Request Body schema: application/json
required
filename
required
string [ 1 .. 255 ] characters

File name for the uploaded image.

content_type
required
string
Enum: "image/jpeg" "image/png" "image/avif" "image/heic" "image/heif" "image/webp"

MIME type for the uploaded image.

file_data_base64
required
string [ 1 .. 2796204 ] characters

Base64-encoded image bytes.

Responses

Request samples

Content type
application/json
{
  • "filename": "hero.webp",
  • "content_type": "image/webp",
  • "file_data_base64": "UklGRiIAAABXRUJQVlA4IBYAAAAwAQCdASoBAAEADsD+JaQAA3AAAAAA"
}

Response samples

Content type
application/json
{
  • "object": "media_asset",
  • "id": "mediaasset123456789abcdef",
  • "object_name": "paywalls/originals/abc123.webp",
  • "original_name": "hero.webp",
  • "original_size": 12345,
  • "original_width": 1024,
  • "original_height": 1024,
  • "formats": {
    },
  • "alt_text": "A dog looking at a phone",
  • "is_decorative": false,
  • "asset_base_url": "https://paywalls-assets.revenuecat.com",
  • "asset_type": "image",
  • "video_metadata": { },
  • "transcoding_status": null
}

Endpoint Reference

All API v2 resources, one page each. General concepts (authentication, pagination, rate limits, error handling) live on the API v2 overview.