API Reference
Every operation of the REST API, generated from the OpenAPI document and grouped by resource.
Every operation of the REST API, generated from the OpenAPI document Subscriby publishes and grouped by resource: the request fields with their types and constraints, the response fields, every refusal, the ability the token must carry, the webhook events the call fires, the MCP tools that wrap it, code samples in seven languages, and a playground that sends the request to api.subscriby.net with your token. Each group is one page; a row below opens it at that operation.
Access Codes API
Access codes are pre-generated single-use subscription activations a creator hands out. Read the overview.
/v1/projects/{project}/plans/{plan}/access-codesList a plan's access codesGET/v1/projects/{project}/plans/{plan}/access-codes/previewPrice a batchPOST/v1/projects/{project}/plans/{plan}/access-codes/bulk-generateGenerate a batch of codesDELETE/v1/projects/{project}/plans/{plan}/access-codes/{accessCode}Revoke an access codeActivity API
Every mutation Subscriby performs, whether from the dashboard, the REST API, an MCP tool call, a Zapier step or a scheduled system task, is recorded against its subject in the activity log. Read the overview.
Alert Destinations API
An alert destination is a place your creator alerts go: one of the accounts linked to your creator account on a connector, or your email address. Read the overview.
/v1/me/alert-destinationsList your alert destinationsPUT/v1/me/alert-destinationsReplace your alert destinationsAnalytics API
Read-only analytics under /v1/analytics/ surface the same figures the creator dashboard renders. Read the overview.
/v1/analytics/dashboardHeadline figuresGET/v1/analytics/earningsEarnings reportGET/v1/analytics/subscribersSubscriber analyticsGET/v1/analytics/transactionsList transactionsGET/v1/analytics/transactions/breakdownTransaction breakdownGET/v1/analytics/plan-performancePlan performanceGET/v1/analytics/connectorsBy connectorGET/v1/analytics/compositionRevenue compositionBroadcasts API
A broadcast sends one message, through the project's connector, to a segment of the project's members. Read the overview.
/v1/projects/{project}/broadcasts/audiencesList every audienceGET/v1/projects/{project}/broadcasts/previewPreview an audiencePOST/v1/projects/{project}/broadcastsSend a broadcastConnectors API
A Subscriby project runs on connectors: the platforms it gates access on, sends messages through and takes payments from. Read the overview.
/v1/connectorsList the connector directoryGET/v1/connectors/{key}Get one connectorGET/v1/projects/{project}/connectorsList a project's installationsGET/v1/projects/{project}/connectors/{key}/installationGet a project's installation of a connectorDELETE/v1/projects/{project}/connectors/{key}/installationDisconnect an installationGET/v1/projects/{project}/connectors/{key}/uninstall-previewPreview an uninstallPOST/v1/projects/{project}/connectors/{key}Install a connectorDELETE/v1/projects/{project}/connectors/{key}Uninstall a connectorPOST/v1/projects/{project}/connectors/{key}/installation/verifyVerify an installationPOST/v1/projects/{project}/connectors/{key}/installation/doctorRun the connector doctorPOST/v1/projects/{project}/connectors/{key}/installation/restore-accessRestore access after a reinstallPATCH/v1/projects/{project}/connectors/{key}/installation/settingsChange an installation's settingsCoupons API
A coupon is one code many subscribers can redeem for money off at checkout: the multi-redemption counterpart to an access code, which is one code for one person and grants access outright without a payment. Read the overview.
/v1/projects/{project}/couponsList a project's couponsPOST/v1/projects/{project}/couponsCreate a couponGET/v1/projects/{project}/coupons/{coupon}Get a couponPATCH/v1/projects/{project}/coupons/{coupon}Update a couponDELETE/v1/projects/{project}/coupons/{coupon}Delete a couponPOST/v1/projects/{project}/coupons/{coupon}/activateActivate a couponPOST/v1/projects/{project}/coupons/{coupon}/deactivateDeactivate a couponCreator Tasks API
A creator task is a grant no connector can give. Read the overview.
/v1/projects/{project}/creator-tasksList a project's creator tasksPOST/v1/projects/{project}/creator-tasks/{task}/completeComplete a creator taskDisaster Recovery API
Everything the Disaster Recovery pages show a creator is readable here: what the health probes found broken, what was done about it and whether it can still be undone, how many members a channel recovery has re-admitted so far, how many self-service recoveries the rolling window still allows, and how ready the account is for the next ban. Read the overview.
/v1/projects/{project}/resources/{resource}/standbyGet a resource's standbyPATCH/v1/projects/{project}/resources/{resource}/standbySwitch a standby's live mirrorDELETE/v1/projects/{project}/resources/{resource}/standbyRemove a resource's standbyGET/v1/projects/{project}/recovery/settingsGet a project's recovery settingsPATCH/v1/projects/{project}/recovery/settingsUpdate a project's recovery settingsGET/v1/projects/{project}/recovery/members/exportExport a project's member listGET/v1/recovery/readinessGet the readiness checklistGET/v1/recovery/incidentsList incidentsGET/v1/recovery/incidents/{incident}Get an incidentGET/v1/recovery/operationsList recovery operationsGET/v1/recovery/operations/{operation}Get a recovery operationGET/v1/recovery/operations/{operation}/roll-callGet a recovery's roll callGET/v1/recovery/allowancesGet the recovery allowancesGET/v1/me/recoveryGet the caller's recovery accountGET/v1/me/recovery/handshakes/{handshake}Poll a recovery handshakeDELETE/v1/me/recovery/handshakes/{handshake}Cancel a recovery handshakePOST/v1/projects/{project}/resources/{resource}/standby/requestRequest a standby for a resourceDELETE/v1/projects/{project}/resources/{resource}/standby/requestWithdraw a standby requestPOST/v1/projects/{project}/resources/{resource}/standby/useUse a resource's standby nowPOST/v1/projects/{project}/resources/{resource}/replacement/requestRequest a replacement for a resourceDELETE/v1/projects/{project}/resources/{resource}/replacement/requestWithdraw a replacement requestDELETE/v1/projects/{project}/recovery/standby-installationRemove a project's standby installationPOST/v1/recovery/operations/{operation}/revertUndo a recoveryPOST/v1/recovery/operations/{operation}/nudgeRemind a recovery's stragglersPOST/v1/recovery/operations/{operation}/notify-membersTell members about a bot replacementPOST/v1/me/recovery/handshakesOpen a recovery handshakePOST/v1/me/recovery/handshakes/{handshake}/confirmConfirm a relink handshakePOST/v1/me/recovery/backup-identityRegister a backup accountDELETE/v1/me/recovery/backup-identityRemove the backup accountPOST/v1/me/recovery/backup-identity/switchSwitch to the backup accountDistribution API
Every project exposes two public URLs: the subscriber portal and the deep link into the project's connector installation, with a start payload that decides what opens. Read the overview.
/v1/projects/{project}/distribution/deep-linkBuild a deep linkGET/v1/projects/{project}/distribution/portal-urlGet the portal URLGroups API
A group is a named bundle of permissions on a team that several collaborators hold at once: put the three people who run the inbox into a Support group and they share its permissions, take one out and they keep only what their own role gives them. Read the overview.
/v1/groupsList groupsPOST/v1/groupsCreate a groupGET/v1/groups/{group}Get a groupPATCH/v1/groups/{group}Update a groupDELETE/v1/groups/{group}Delete a groupPUT/v1/groups/{group}/membersReplace a group's membersIdentities API
A linked identity is an account you hold on a connector, tied to your Subscriby creator account. Read the overview.
/v1/me/identitiesList the caller's linked accountsDELETE/v1/me/identities/{identity}Unlink an accountMe API
GET /v1/me is the first call a client makes. Read the overview.
Members API
Members are the project-scoped subscribers. Read the overview.
/v1/projects/{project}/membersList a project's membersGET/v1/projects/{project}/members/{member}Get a memberGET/v1/projects/{project}/members/{member}/identitiesList a member's connected accountsPOST/v1/projects/{project}/members/{member}/banBan a memberPOST/v1/projects/{project}/members/{member}/kickKick a memberPOST/v1/projects/{project}/members/{member}/unbanUnban a memberDELETE/v1/projects/{project}/members/{member}/identities/{link}Disconnect a member's accountNotifications API
Every alert Subscriby sends a creator (a sale, a support backlog, a bot or channel that went silent, a billing or security notice, a pass window, an onboarding nudge) also lands in the Notifications Center: the sidebar entry with its unread count and popover, and the page at /notifications. Read the overview.
/v1/me/notificationsList the caller's notificationsPOST/v1/me/notifications/read-allMark every notification readPOST/v1/me/notifications/{notification}/readMark a notification readPass Windows API
A pass window is one dated stretch of access on a kind: pass plan: the Saturday 09:00–12:00 a buyer of a match-day pass actually gets. Read the overview.
/v1/projects/{project}/pass-windowsList a project's pass windowsGET/v1/projects/{project}/pass-windows/{window}Get a pass windowPOST/v1/projects/{project}/plans/{plan}/pass-windowsPlace a pass window by handPOST/v1/projects/{project}/pass-windows/{window}/cancelCancel a pass windowPOST/v1/projects/{project}/pass-windows/{window}/remindRemind a window's holdersPayment Methods API
Every project configures one or more payment providers so subscribers can buy plans. Read the overview.
/v1/projects/{project}/payment-methodsList a project's payment methodsGET/v1/projects/{project}/payment-methods/{method}Get a payment methodDELETE/v1/projects/{project}/payment-methods/{method}Delete a payment methodPOST/v1/projects/{project}/payment-methods/{method}/activateActivate a payment methodPOST/v1/projects/{project}/payment-methods/{method}/deactivateDeactivate a payment methodPOST/v1/projects/{project}/payment-methods/{method}/syncSync a payment method's plansPing API
The one endpoint that needs no token. Read the overview.
Plans API
A plan is what a project sells: the price, the currency, the billing cycle or the dated windows, the eligibility rules and the resources a purchase unlocks. Read the overview.
/v1/projects/{project}/plansList a project's plansPOST/v1/projects/{project}/plansCreate a planGET/v1/projects/{project}/plans/{plan}Get a planPATCH/v1/projects/{project}/plans/{plan}Update a planDELETE/v1/projects/{project}/plans/{plan}Delete a planPOST/v1/projects/{project}/plans/{plan}/publishPublish a planPOST/v1/projects/{project}/plans/{plan}/unpublishUnpublish a planPOST/v1/projects/{project}/plans/orderArrange the storefront orderPOST/v1/projects/{project}/plans/{plan}/successorStart the next seasonProjects API
A project is the container for one membership business: its plans, its members and their subscriptions, its payment methods, the resources a purchase unlocks and the connectors it runs on. Read the overview.
/v1/projectsList projectsPOST/v1/projectsCreate a projectGET/v1/projects/{project}Get a projectPATCH/v1/projects/{project}Update a projectDELETE/v1/projects/{project}Delete a projectPOST/v1/projects/{project}/archiveArchive a projectPOST/v1/projects/{project}/restoreRestore a projectResources API
Resources are what a plan unlocks: a place a connector gates (a channel, group or supergroup on Telegram today; each connector's own kinds as it launches) or a manually-tracked perk such as a PDF, a token or a URL. Read the overview.
/v1/projects/{project}/resourcesList a project's resourcesPOST/v1/projects/{project}/resourcesCreate a manual perkGET/v1/projects/{project}/resources/{resource}Get a resourcePATCH/v1/projects/{project}/resources/{resource}Update a resourceDELETE/v1/projects/{project}/resources/{resource}Delete a resourcePOST/v1/projects/{project}/resources/link-requestsRequest a place linkPOST/v1/projects/{project}/resources/{resource}/unlinkUnlink a resource's placePOST/v1/projects/{project}/resources/{resource}/activateActivate a resourcePOST/v1/projects/{project}/resources/{resource}/deactivateDeactivate a resourceRoles API
A role is the permission set a collaborator holds on a team. Read the overview.
/v1/rolesList rolesPOST/v1/rolesCreate a roleGET/v1/roles/{role}Get a rolePATCH/v1/roles/{role}Update a roleDELETE/v1/roles/{role}Delete a roleSubscriptions API
A subscription is one member's purchase of one plan: the row that says who bought what, on which payment method, for how much, and until when. Read the overview.
/v1/subscriptionsList subscriptionsGET/v1/subscriptions/{subscription}Get a subscriptionGET/v1/subscriptions/{subscription}/grantsList a subscription's grantsPOST/v1/subscriptions/{subscription}/cancelCancel a subscriptionPOST/v1/subscriptions/{subscription}/pausePause a subscriptionPOST/v1/subscriptions/{subscription}/unpauseUnpause a subscriptionPOST/v1/subscriptions/{subscription}/reactivateReactivate a subscriptionPOST/v1/subscriptions/{subscription}/remindRemind a pass holderPOST/v1/subscriptions/{subscription}/grants/reissueReissue a subscription's accessSupport Inbox API
The support inbox is where a member who writes to your project bot something it does not recognise ends up: one durable support conversation per (project, member, channel), the saved replies your team answers with, and the project's support settings that decide whether the inbox is open, how you hear about a new thread and how replies are signed. Read the overview.
/v1/support/conversationsList support conversationsGET/v1/support/conversations/{conversation}Get a support conversationGET/v1/support/conversations/{conversation}/messagesList a conversation's messagesPOST/v1/support/conversations/{conversation}/messagesReply to a memberGET/v1/projects/{project}/support/canned-repliesList a project's saved repliesPOST/v1/projects/{project}/support/canned-repliesCreate a saved replyGET/v1/projects/{project}/support/canned-replies/{reply}Get a saved replyPATCH/v1/projects/{project}/support/canned-replies/{reply}Update a saved replyDELETE/v1/projects/{project}/support/canned-replies/{reply}Delete a saved replyGET/v1/projects/{project}/support/settingsGet a project's support settingsPATCH/v1/projects/{project}/support/settingsUpdate a project's support settingsPOST/v1/support/conversations/{conversation}/resolveResolve a support conversationPOST/v1/support/conversations/{conversation}/assignAssign a support conversationPOST/v1/support/conversations/{conversation}/reopenReopen a support conversationPOST/v1/support/conversations/{conversation}/blockBlock a support contactPOST/v1/support/conversations/{conversation}/unblockUnblock a support contactTeam Members API
Team members are the humans who collaborate inside a team: the creator who owns it and the people they invited to help run its projects. Read the overview.
/v1/teams/{team}/membersList a team's membersPOST/v1/teams/{team}/membersInvite a team memberGET/v1/teams/{team}/members/{member}Get a team memberDELETE/v1/teams/{team}/members/{member}Remove a team memberPATCH/v1/teams/{team}/members/{member}/roleChange a team member's roleDELETE/v1/teams/{team}/invitations/{invitation}Withdraw an invitationTeams API
Teams group creators, roles, and projects. Read the overview.
/v1/teamsList teamsPOST/v1/teamsCreate a teamGET/v1/teams/currentGet the current teamGET/v1/teams/{team}Get a teamPATCH/v1/teams/{team}Rename a teamDELETE/v1/teams/{team}Delete a teamTokens API
Personal access tokens are what authorize every REST and MCP call. Read the overview.
/v1/tokensList the caller's tokensPOST/v1/tokensMint a tokenGET/v1/tokens/{token}Get a tokenDELETE/v1/tokens/{token}Revoke a tokenWebhook Deliveries API
Every event Subscriby posts to one of your webhook endpoints is a delivery: one row per endpoint per event, carrying the signed envelope that was sent, the target's response and where the row is on the retry ladder. Read the overview.
/v1/webhook-deliveriesList webhook deliveriesGET/v1/webhook-deliveries/{delivery}Get a webhook deliveryPOST/v1/webhook-deliveries/retry-deadRetry every recent dead deliveryPOST/v1/webhook-deliveries/{delivery}/retryRetry a webhook deliveryWebhook Endpoints API
A webhook endpoint is a URL of yours that Subscriby posts events to, with the event families it subscribes to and a signing secret you verify each delivery against. Read the overview.
/v1/webhook-endpointsList webhook endpointsPOST/v1/webhook-endpointsRegister a webhook endpointGET/v1/webhook-endpoints/{endpoint}Get a webhook endpointDELETE/v1/webhook-endpoints/{endpoint}Delete a webhook endpointPOST/v1/webhook-endpoints/{endpoint}/rotate-secretRotate a webhook endpoint's secretPOST/v1/webhook-endpoints/{endpoint}/testTest-fire a webhook endpointPOST/v1/webhook-endpoints/{endpoint}/pausePause a webhook endpointPOST/v1/webhook-endpoints/{endpoint}/resumeResume a webhook endpointWebhook Events API
A read-only polling endpoint that surfaces the most recent webhook deliveries for a given event type. Read the overview.
How is this guide?