How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog subscriptions API

The subscriptions API from PostHog — 8 operation(s) for subscriptions.

PostHog subscriptions API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 16 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

16 operations 8 paths 13 schemas 2 DELETE6 GET2 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 16

Across 8 paths, the API surfaces 16 operations — 2 DELETE, 6 GET, 2 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

subscriptions 16
GET
/api/environments/{environment_id}/subscriptions/deprecated
environments_subscriptions_list 10 params → 200
POST
/api/environments/{environment_id}/subscriptions/deprecated
environments_subscriptions_create 1 param body → 201
GET
/api/environments/{environment_id}/subscriptions/{id}/deprecated
environments_subscriptions_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/subscriptions/{id}/deprecated
environments_subscriptions_update 2 params body → 200
PATCH
/api/environments/{environment_id}/subscriptions/{id}/deprecated
environments_subscriptions_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/subscriptions/{id}/deprecated
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
environments_subscriptions_destroy 2 params → 405
POST
/api/environments/{environment_id}/subscriptions/{id}/test-delivery/deprecated
environments_subscriptions_test_delivery_create 2 params → 202
GET
/api/environments/{project_id}/subscriptions/{subscription_id}/deliveries/
List subscription deliveries
subscriptions_deliveries_list 4 params → 200
GET
/api/environments/{project_id}/subscriptions/{subscription_id}/deliveries/{id}/
Retrieve subscription delivery
subscriptions_deliveries_retrieve 3 params → 200
GET
/api/projects/{project_id}/subscriptions/
subscriptions_list 10 params → 200
POST
/api/projects/{project_id}/subscriptions/
subscriptions_create 1 param body → 201
GET
/api/projects/{project_id}/subscriptions/{id}/
subscriptions_retrieve 2 params → 200
PUT
/api/projects/{project_id}/subscriptions/{id}/
subscriptions_update 2 params body → 200
PATCH
/api/projects/{project_id}/subscriptions/{id}/
subscriptions_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/subscriptions/{id}/
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
subscriptions_destroy 2 params → 405
POST
/api/projects/{project_id}/subscriptions/{id}/test-delivery/
subscriptions_test_delivery_create 2 params → 202

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Subscription (25 properties), PatchedSubscription (25 properties), SubscriptionDelivery (17 properties), UserBasic (9 properties). Each schema is shown below with its type and property counts.

UserBasic
object
9 properties 4 required
TargetTypeEnum
string
email - Email slack - Slack webhook - Webhook
SubscriptionDelivery
object
17 properties 17 required
BlankEnum
NullEnum
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
SubscriptionFrequencyEnum
string
daily - Daily weekly - Weekly monthly - Monthly yearly - Yearly
PaginatedSubscriptionList
object
4 properties 2 required
PatchedSubscription
object
Standard Subscription serializer.
25 properties
Subscription
object
Standard Subscription serializer.
25 properties 11 required
PaginatedSubscriptionDeliveryList
object
3 properties 1 required
SubscriptionDeliveryStatusEnum
string
starting - Starting completed - Completed failed - Failed skipped - Skipped
ByweekdayEnum
string
monday - Monday tuesday - Tuesday wednesday - Wednesday thursday - Thursday friday - Friday saturday - Saturday sunday - Sunday

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-subscriptions-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.