Run Subscriby (formerly MemberPass) paid communities: plans, coupons, access codes, members, subscriptions, broadcasts, support and analytics.
Explore 164 workflow actions for Subscriby (MemberPass), including account permissions and operation limits.
86 read actions78 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Activate a coupon
Write
Switches the code on so new redemptions are accepted again, within its window and cap.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Activate a resource
Write
The switch on the dashboard's resource row, on.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Approve an affiliate
Write
Approves a pending or suspended affiliate: their code counts from now on, and they receive their link, code and the programme's terms in their chat and by mail.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive a link
Write
Answers 204.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive a project
Write
Switches the project off: active becomes false, the portal stops selling, and every plan, member and payment method is kept.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Arrange the storefront order
Write
Arrange the storefront order.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign a support conversation
Write
Assign a support conversation.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Ban a member
Write
Ban a member.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Block a support contact
Write
Block a support contact.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Build a deep link
Read
Builds a start link against the project's connected installation.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
By connector
Read
Members, access and revenue per connector: one row for every connector the scope's projects run or ever granted access on.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Cancel a pass window
Write
Cancel a pass window.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel a subscription
Write
Cancel a subscription.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change a link
Write
Any subset of the create shape; omitted fields keep their stored value.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change a sequence
Write
Change a sequence.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change the settings
Write
Change the settings.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check the API is up
Read
Check the API is up.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Complete a creator task
Write
Complete a creator task.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a coupon
Write
Create a coupon.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a group
Write
Create a group.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a link
Write
Create a link.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a manual perk
Write
Create a manual perk.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a plan
Write
POST takes the same shape it returns: kind plus the one matching block.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a saved reply
Write
Create a saved reply.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a sequence
Write
Create a sequence.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deactivate a coupon
Write
Deactivate a coupon.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deactivate a resource
Write
Deactivate a resource.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a coupon
Write
Delete a coupon.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a group
Write
Delete a group.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a plan
Write
Removes the plan and emits plan.deleted with a snapshot taken before the row disappears.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a project
Write
Deletes the project and everything under it.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a resource
Write
Deletes the row.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a saved reply
Write
Delete a saved reply.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a sequence
Write
Puts the sequence out of use and answers 204: every member part-way through leaves it as sequence.exited with the reason deleted, the row and its history stay for the figures, and the id stops.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete the programme
Write
Removes the programme.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Disconnect a member's account
Write
Disconnect a member's account.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Disconnect an installation
Write
Disconnect an installation.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Earnings report
Read
The full earnings breakdown (gross, fees, net, transaction count) plus a timeseries bucketed by granularity: day (the default), week or month.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Enrol a member by hand
Write
Enrol a member by hand.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Generate a batch of codes
Write
Queues a batch of codes for the plan and answers 202 Accepted at once; the codes are written by a background job and delivered the way exporttype names.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a coupon
Read
One coupon with its currency ISO code loaded.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a group
Read
One group with its permissions and memberids, which are returned when the group is read individually or after a write and omitted from list responses so a listing stays one query.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a link
Read
One link with its plan's name loaded.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a member
Read
One member with their connected accounts embedded as identities.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a pass window
Read
One window, with sellable and holders resolved for it.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a payment method
Read
The method without its credentials.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a plan
Read
One plan in the same discriminated shape as the list.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a project
Read
One project.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a project's installation of a connector
Read
The project's installation of that connector in the live role, in whatever state, in the shape the installations list describes.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a project's support settings
Read
| Field | Type | Notes | | -------------- | -------------- |.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a referral
Read
One referral: how the creator arrived (source is link, codeatsignup or botdeeplink), whether their first paid invoice converted them and on which plan, the commissionpercent locked onto them at.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a referral
Read
One referral: how the friend arrived (source is portallink, connectorlink or codeatcheckout; connector names the bot's platform on a connector link), whether their first payment settled, and.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a resource
Read
One resource with its place, when it has one.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a role
Read
One role with its permission codes.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a saved reply
Read
One snippet.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a sequence
Read
One sequence with its steps and its counts.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a subscription
Read
One subscription with its grants embedded.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a support conversation
Read
One thread.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a team
Read
The team if the caller belongs to it; 404 RESOURCENOTFOUND otherwise, never 403, so foreign-team.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a team member
Read
One collaborator, with their email, which this route always includes because it.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get a webhook delivery
Read
Get a webhook delivery.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get an affiliate
Read
One affiliate with their balances per currency.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get one connector
Read
One card by key, registered or on the roadmap, in the shape the directory lists.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get the caller's account
Read
The caller's account; never paginated.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get the current team
Read
Exactly the team the token is scoped to via scope:team:<uuid.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get the portal URL
Read
The portal URL always uses the project's current handle.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get the programme
Read
Get the programme.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Get your partnership
Read
Where you stand, whole.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Headline figures
Read
Total revenue, total transactions, total users and MRR, each with a trend relative to the compareperiod window and a sparkline.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Install a connector
Write
Install a connector.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Kick a member
Write
Moves the member to churned, removes them from every resource and emits member.kicked with the optional reason.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
List a conversation's messages
Read
The thread's messages oldest first, 50 per page.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a member's connected accounts
Read
The member's connected accounts, preferred first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a plan's access codes
Read
Pages the plan's codes, newest first, fifty per page unless you say otherwise.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's coupons
Read
List a project's coupons.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's creator tasks
Read
status is open (the default: tasks not yet done whose grant still.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's installations
Read
Every installation the project holds, live and standby, oldest first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's links
Read
List a project's links.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's members
Read
Newest first, paged with page and perpage (default 25; limit is.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's pass windows
Read
The project's windows across every pass.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's payment methods
Read
Every payment method attached to the project, newest first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's plans
Read
Pages the project's plans, every kind together, newest first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's resources
Read
Newest first, paged with page and perpage, sortable with.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's saved replies
Read
Every snippet on the project in the creator's order (sortorder.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a project's sequences
Read
List a project's sequences.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a sequence's enrolments
Read
List a sequence's enrolments.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a subscription's grants
Read
Every grant the purchase holds, one per resource and dated window, oldest.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List a team's members
Read
The team's owner as the first row followed by every member.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List affiliates
Read
List affiliates.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List every audience
Read
All thirteen segments with labels, descriptions and current counts, so a UI can offer them without hard-coding the list.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List groups
Read
Every group across the teams the caller sees, newest first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List payouts
Read
Pages the payouts the creator recorded, newest first; affiliateid narrows to one affiliate.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List projects
Read
Every project visible to the token, newest first, paged with page and perpage (default 25).
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List referrals
Read
List referrals.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List rewards
Read
List rewards.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List roles
Read
Every role across the teams the caller can see, with its permission codes.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List subscriptions
Read
The held subscriptions across every project the token reaches, newest first, paged.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List support conversations
Read
The queue across every project the token can reach, newest activity first, 25.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List teams
Read
Every team the caller owns or is a member of; teams belonging to other creators are invisible.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List the activity ledger
Read
List the activity ledger.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List the caller's linked accounts
Read
Every account linked to the caller's creator account, by connector then purpose.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List the caller's notifications
Read
Newest first, paginated with page and perpage like every list.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List the cancellation screens
Read
List the cancellation screens.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List the checkouts
Read
List the checkouts.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List the connector directory
Read
Every connector Subscriby knows, lane by lane, installable connectors first, each with its badges and, for a registered one, its whole manifest and the connect form.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List transactions
Read
A keyset-paginated list of payments for one project.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List webhook deliveries
Read
The team's deliveries across every endpoint, newest first, 25 per page (perpage 1.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List your alert destinations
Read
Your destinations, primary first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List your commissions
Read
Pages the commission ledger, newest first: one commission row per paid.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List your payouts
Read
Pages the cash Subscriby paid you, newest first: the amount, the rail it went by (method is paypal, wise, remitly or crypto), the transfer's reference, when it left and how many commissions it.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
List your referrals
Read
Pages the creators you brought to Subscriby, newest first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Mark a notification read
Write
Mark a notification read.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mark every notification read
Write
Mark every notification read.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
One link's funnel
Read
The same row for one link, under data.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Pause a subscription
Write
Suspends access: the member is removed from every linked resource, paymentstatus becomes paused and pausedat is stamped.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Place a pass window by hand
Write
Places a window by hand on a kind: pass plan.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Plan performance
Read
A per-plan breakdown for one project: active subscribers, revenue in the window, payments in the window and the average ticket.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Poll recent webhook events
Read
The most recent deliveries of one event type, newest first, as.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Preview an audience
Read
Sizes a broadcast without sending it.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Preview an uninstall
Read
Preview an uninstall.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Price a batch
Read
Prices a batch of quantity codes without queuing it, so a caller can show the worst-case charge before generating.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Publish a plan
Write
Puts the plan on sale: active becomes true, salescapsold restarts at 0, and plan.activated fires.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reactivate a subscription
Write
Calls off a scheduled cancellation at the gateway and locally: the counterpart to cancel, and the win-back path.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Read a subject's activity
Read
The newest entries recorded against one subject, limit at a time (50 by default, 200 at most), newest first.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Read the figures
Read
Read the figures.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Read the settings
Read
Read the settings.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Record a payout
Write
Record a payout.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reissue a subscription's access
Write
Reissue a subscription's access.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remind a pass holder
Write
Remind a pass holder.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remind a window's holders
Write
Nudges everyone who bought the window but has not yet joined, re-attaching their invite links.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Rename a team
Write
Rename a team.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reopen a support conversation
Write
Reopen a support conversation.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replace a group's members
Write
Replace a group's members.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replace your alert destinations
Write
Takes the complete list you want to keep; anything not in it is removed.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reply to a member
Write
Reply to a member.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Request a place link
Write
A place cannot be created from the API: only the connector can prove it administers the place.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resolve a support conversation
Write
Resolve a support conversation.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Restore a project
Write
Switches an archived project back on.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Restore access after a reinstall
Write
Restore access after a reinstall.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Revenue composition
Read
How the window's revenue and payments are composed, as the five donuts the dashboards draw: transaction fees by payment provider, settled transactions by plan kind, gross revenue by currency,.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Revoke an access code
Write
Deletes an unredeemed code so it can no longer be claimed.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the connector doctor
Write
Run the connector doctor.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a broadcast
Write
Send a broadcast.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set up or change the programme
Write
Set up or change the programme.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Start the next season
Write
Start the next season.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Subscriber analytics
Read
New sign-ups, cancellations, churn rate, trial-to-paid conversion and the status distribution of the window.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Suspend an affiliate
Write
Their code stops counting new friends and nothing new is earned; what they already earned stays and can still be paid.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Switch the programme off
Write
Switch the programme off.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Switch the programme on
Write
Links and codes attribute again and settled payments earn again.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
The project's funnel
Read
The project's funnel.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Transaction breakdown
Read
USD-normalised successful-payment totals grouped by one dimension: plan, paymentprovider, currency or project.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
Unban a member
Write
Moves a banned member to churned and emits member.unbanned.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unblock a support contact
Write
Reverses a block.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Uninstall a connector
Write
Uninstall a connector.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlink a resource's place
Write
Detaches the place from a resource, so space reads null and the row becomes a placeholder.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unpause a subscription
Write
Restores access with fresh invite links: the ones revoked at pause never come back.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unpublish a plan
Write
Takes the plan off sale: active becomes false and plan.deactivated fires.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a coupon
Write
Accepts the same fields as create, all optional.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a group
Write
Update a group.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a plan
Write
The same discriminated shape as create, with every field optional.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a project's support settings
Write
Update a project's support settings.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a resource
Write
Update a resource.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a saved reply
Write
Update a saved reply.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
Verify an installation
Write
Verify an installation.
Permissions and limits
Account permissions
A Subscriby personal access token (Settings, Tokens) with the abilities each call lists
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Subscriby (MemberPass). A saved workflow is not a completed provider action.
Marketing ยท CONNECTION
