Bring Subscriby into
the flow of work.
A little less busywork with Subscriby.
Project8 capabilities+
- Archive a project
Soft-delete a project
- Create a project
Create a new project
- Delete a project
Permanently delete a project
- Find a project by handle
Return the first project whose handle matches
- Get a project
Fetch a project by UUID
- List projects
List all projects visible to the current team
- Restore a project
Restore an archived project
- Update a project
Update an existing project
Pass Window5 capabilities+
- Cancel a pass window
Cancel a window before it opens; holders are moved to the next window or marked for refund
- Create a pass window
Add one dated window to a pass plan's schedule
- Get a pass window
Fetch one window by UUID, with its holder count and whether it is still on sale
- List pass windows
List the dated access windows a project's pass plans generate, with their IDs
- Remind the pass window queue
Nudge every holder of the window who has not joined yet
Broadcast3 capabilities+
- List broadcast audiences
List every audience segment with its current recipient count
- Preview a broadcast audience
Size an audience without sending anything
- Send a broadcast
Queue a Telegram message to a segment of the project members
Plan10 capabilities+
- Arrange the storefront order of plans
Pin the order the portal and the bot list the plans in; an empty list restores the built-in order
- Create a plan
Create a subscription plan under a project
- Delete a plan
Permanently delete a plan
- Find a plan by name
Return the first plan whose name matches
- Get a plan
Fetch a plan by UUID
- List plans
List all plans under a project
- Publish a plan
Make a plan publicly purchasable
- Start the next season of a pass series
Create the successor of a pass series plan, carrying its rules onto the next run of windows
- Unpublish a plan
Hide a plan from purchase
- Update a plan
Update plan attributes
Subscription9 capabilities+
- Cancel a subscription
Cancel a subscription immediately or at period end
- Get a subscription
Fetch a subscription by UUID
- List subscriptions
List subscriptions filtered by status or plan
- List subscription grants
List the access grants a subscription holds: one per resource and pass window, with the connector, how access was given, its state and why it failed if it did
- Pause subscription access
Suspend the member resource access. Billing is unaffected and continues on schedule.
- Reactivate a subscription
Call off a scheduled cancellation. Stripe only; other providers end the agreement outright.
- Reissue subscription grants
Revoke the access grants a member holds (every resource, or one) and issue fresh ones. The member is sent the new links by the bot.
- Remind a pass holder
Nudge a pass holder who has not joined their window yet. Returns whether anything was sent.
- Unpause subscription access
Restore suspended access and issue fresh invite links
Member7 capabilities+
- Ban a member
Ban a member from the project community
- Get a member
Fetch a member by UUID
- Kick a member
Remove a member without a permanent ban
- List members
List members of a project
- List a members connected accounts
List the platform accounts a member has connected, with the preferred one marked
- Unban a member
Lift a previous ban
- Disconnect a members connected account
Disconnect one of a member's platform accounts; refused when it is their last way to sign in
Support Conversation9 capabilities+
- Assign a support conversation
Hand the conversation to a team member, or clear the assignment
- Block a support contact
Stop the member from reaching the inbox; their messages are dropped until unblocked
- Get a support conversation
Fetch one conversation by UUID
- List support conversations
List conversations, newest activity first
- List support messages
Fetch the messages in a conversation, oldest first
- Reopen a support conversation
Put a resolved conversation back in the open queue
- Reply to a support conversation
Send a reply the member receives on Telegram
- Resolve a support conversation
Clear the conversation from the open queue
- Unblock a support contact
Let a blocked member reach the inbox again
Canned Reply5 capabilities+
- Create a canned reply
Save a reply snippet to the project's support picker
- Delete a canned reply
Remove a saved reply. Replies already sent with it are untouched.
- Get a canned reply
Fetch one saved reply by UUID
- List canned replies
List the saved replies in a project's support picker
- Update a canned reply
Change a saved reply. Fields you leave out keep their stored values.
Support Inbox2 capabilities+
- Get support inbox settings
Read a project's support inbox settings
- Update support inbox settings
Change a project's support inbox settings. Fields you leave out keep their stored values.
Subscriber1 capabilities+
- Find a subscriber by connector account
Return the subscriber holding a given account on a connector
Access Code4 capabilities+
- Bulk generate access codes
Generate a batch of single-use access codes for a plan
- List access codes
List all access codes under a plan
- Delete an access code
Revoke a single access code
- Preview access code generation
Dry-run generation to preview the codes that would be issued
Coupon7 capabilities+
- Activate a coupon
Switch a code back on so subscribers can redeem it
- Create a coupon
Issue a discount code any number of subscribers can redeem for money off their first payment
- Deactivate a coupon
Retire a code safely: new redemptions stop, recorded ones are kept
- Delete a coupon
Remove a code and its redemption history. Refused while a checkout still holds it.
- Get a coupon
Fetch a coupon by UUID
- List coupons
List a project's coupons, optionally narrowed by switch state or exact code
- Update a coupon
Change a coupon. Fields you leave out keep their stored values.
Creator Task2 capabilities+
- Complete a creator task
Mark a hand-arranged perk as handed over: the grant is issued and creator_task.completed then member.resource_added fire
- List creator tasks
List the hand-arranged perks a creator still has to hand over in a project (one task per subscriber and manual resource, oldest first), or the ones already done
Recovery21 capabilities+
- Get recovery allowances
How many self-service Disaster Recoveries of each kind the creator may still run, what support has released on top, and when the allowance returns
- Get a recovery incident
Fetch one Disaster Recovery incident by UUID
- Get a recovery operation
Fetch one Disaster Recovery operation by UUID, with whether it can still be undone
- Get recovery readiness
The Disaster Recovery readiness checklist for the creator: every line with its state, and the totals
- Get a recovery roll call
Where the re-admission after one channel recovery stands: members re-admitted, joined, still outside, and whether a reminder may go out now
- Get recovery settings
One project's Disaster Recovery settings: automatic failover and its fee consent, how members are told after a swap, whether a standby installation is kept
- Get a resource standby
The standby kept for one resource: health, mirror switch, when it was last probed and written to
- List recovery incidents
What the health probes found broken (open by default), with the reason in the connector's words
- List recovery operations
Every recovery ever run, by the creator, the platform or on demand, with its state and undo window
- Notify members of a recovery
Email every member the project can reach that its bot changed after a bot replacement, at the per-email fee; sent once per recovery
- Nudge pending readmissions
Remind, with a fresh link, every member a channel recovery re-admitted who has not joined yet
- Remove a resource standby
Stop keeping a standby for one resource; the chat itself is untouched
- Remove a standby installation
Stop keeping the standby installation (the spare bot) registered for a project
- Request a resource replacement
Ask the creator, through the connector, to pick the chat that replaces a resource's; the swap runs when they choose
- Request a resource standby
Ask the creator, through the connector, to pick the chat that becomes the standby for one resource
- Revert a recovery operation
Undo a completed recovery inside its window: a swapped channel put back (name the resource), or the previous sign-in account restored
- Set a resource standby mirror
Switch the live mirror into a resource's standby on or off
- Update recovery settings
Change automatic failover (with the fee consent) and how members are told after a swap; fields left out keep their value
- Use a resource standby
Swap a resource onto its standby now: old links revoked, every active member re-admitted, the standby consumed
- Withdraw a resource replacement request
Take back the replacement request the creator has open on the connector
- Withdraw a resource standby request
Take back the standby request the creator has open on the connector
Resource9 capabilities+
- Activate a resource
Switch a resource back on so it is delivered to members
- Create a resource
Create a manual perk (a PDF, a token, a URL) the creator hands over by hand; a place a connector gates is linked with Request Link
- Deactivate a resource
Switch a resource off without deleting it; new members stop receiving it
- Delete a resource
Permanently delete a resource
- Get a resource
Fetch a resource by UUID
- List resources
List the resources attached to a project, or only those of one kind or on one connector
- Request a resource link
Ask the creator, through the connector, to pick the place a new resource will be (a kind its connector gates, such as telegram:channel); it appears when they choose
- Unlink a resource
Detach a resource from delivery without deleting it
- Update a resource
Change the title, description or switch. Fields you leave out keep their stored values.
Payment Method6 capabilities+
- Activate a payment method
Offer the gateway at checkout again. A Stripe method whose Connect onboarding never finished is refused.
- Deactivate a payment method
Stop offering the gateway at checkout; existing subscriptions keep billing
- Delete a payment method
Remove the gateway from the project
- Get a payment method
Fetch a payment method by UUID
- List payment methods
List all payment methods for a project
- Sync plans to a payment method
Queue a re-sync of the project's plans to the gateway. Answers 202 once the job is queued.
Webhook Endpoint8 capabilities+
- Create a webhook endpoint
Register a new webhook endpoint
- Delete a webhook endpoint
Remove a webhook endpoint
- Get a webhook endpoint
Fetch one webhook endpoint by UUID
- List webhook endpoints
List all webhook endpoints for the current team
- Pause a webhook endpoint
Stop deliveries to the endpoint without deleting it
- Resume a webhook endpoint
Restart deliveries to a paused endpoint
- Rotate the signing secret
Rotate the HMAC signing secret for a webhook endpoint
- Send a test delivery
Trigger a test delivery from Subscriby to the endpoint
Webhook Delivery4 capabilities+
- Get a webhook delivery
Fetch one delivery by UUID, with the payload the endpoint received and the last response
- List webhook deliveries
List the team's delivery log, newest first, optionally narrowed by status
- Retry a webhook delivery
Queue a failed or dead-lettered delivery again. Pending and delivered rows are refused.
- Retry dead lettered deliveries
Queue every dead-lettered delivery since a point in time again
Account1 capabilities+
- Get the current account
Fetch the creator the API token belongs to: the team it is scoped to, every team held, plan capabilities, connected accounts and alert destinations
Notification3 capabilities+
- List notifications
List the entries of the notification centre, newest first: every alert Subscriby sent the creator, with its class, title, body, where it points and whether it was read
- Mark all notifications read
Mark every unread entry of the notification centre read in one call and learn how many were marked
- Mark a notification read
Mark one entry of the notification centre read, so the dashboard bell stops counting it
Token3 capabilities+
- List API tokens
List all API tokens for the current team
- Get an API token
Fetch an API token by UUID
- Revoke an API token
Revoke an API token immediately
Team6 capabilities+
- Create a team
Create a team. Growth tier only.
- Delete a team
Permanently delete a team and everything scoped to it. Owner only.
- Get a team
Fetch a team by UUID
- Get the current team
Fetch the team that owns the API token
- List teams
List all teams the caller belongs to
- Update a team
Rename a team. Owner only.
Team Member6 capabilities+
- Cancel a team invitation
Withdraw an invitation nobody has accepted yet
- Get a team member
Fetch a single team member
- Invite a team member
Invite someone by email to an existing role on the team
- List team members
List all members of a team
- Remove a team member
Remove a collaborator from the team. The owner cannot be removed.
- Change a team member role
Move a collaborator onto a different role. The owner cannot be re-roled.
Role5 capabilities+
- Create a role
Create a permission role in a team. Growth tier only.
- Delete a role
Delete a role. Creator only, unless you own the team.
- Get a role
Fetch a role by UUID
- List roles
List all roles defined for the current team
- Update a role
Rename a role and replace its permissions
Group6 capabilities+
- Create a group
Create a permission group in a team. Growth tier only.
- Delete a group
Delete a group. Members stay in the team.
- Get a group
Fetch a group by UUID
- List groups
List all groups for the current team
- Sync group members
Replace the membership wholesale. Anyone left out is removed.
- Update a group
Rename a group and replace its permissions
Activity1 capabilities+
- List activity log entries
List activity log entries for a subject
Connector12 capabilities+
- Disconnect a connector
Disconnect a project's installation: the connector withdraws it, the credentials are wiped, the row stays and members keep their access
- Get a connector
Fetch one Connectors Marketplace card by key: its lane, badges, manifest and the form that connects it
- Get a connector installation
Fetch a project's live installation of one connector, with its state and health
- Get a connector uninstall preview
Show what uninstalling would touch, changing nothing: resources, live grants, emptied plans, the subscriptions on them
- Install a connector
Install a connector on a project as a pending installation the creator then connects from the dashboard
- List connectors
List the Connectors Marketplace: every connector Subscriby knows, lane by lane, with its badges, manifest and connect form
- List connector installations
List every connector installation a project holds, live and standby, with its state and health
- Restore access after a reinstall
Bring the places an uninstall detached back once the connector is connected again, and hand every live purchase of a plan granting them fresh access
- Run the connector doctor
Verify the installation and ask the connector about every resource it gates; one report with a finding per check
- Uninstall a connector
Revoke the grants, detach the resources and keep the row; the two opt-ins act on the plans left with nothing to grant
- Update connector installation settings
Change an installation's declared settings; keys are the field names the connector declares
- Verify a connector installation
Ask the connector whether the installation still answers and record the verdict
Distribution2 capabilities+
- Get portal URL
Fetch the public portal URL for a project
- Get a deep link
Generate a deep link into the project's installation targeting an access code, plan, or custom payload
Analytics8 capabilities+
- Get connector analytics
Fetch members, access and revenue per connector
- Get dashboard analytics
Fetch aggregated dashboard metrics
- Get earnings analytics
Fetch earnings time-series data
- Get plan performance
Fetch per-plan performance analytics for a project
- Get revenue composition
Fetch fees by provider, transactions by plan kind, revenue by currency, payment outcomes and MRR by plan
- Get subscriber analytics
Fetch subscriber growth analytics
- Get transaction breakdown
Fetch a transaction breakdown by dimension
- List transactions
List raw transactions for a project
Frequently asked
questions.
What could an Ambacti integration do with Subscriby?
The documented operations include Project: Archive a project; Project: Create a project; Project: Delete a project; Project: Find a project by handle.
Could I keep a workflow read-only?
For a read-only workflow, limit account permissions to reading data and exclude actions that create, update, or delete records.
Will every action run automatically?
Choose which steps could run on their own and which should pause for review. Changes should follow the permissions and approval rules you set.
Do I need to review actions in Subscriby?
Decide which work could run on its own and which steps need your review.