Wallkit API
Build an integration that identifies members, presents plans and Pricings, manages account records and decides content access. Wallkit also supports teams, event passes, sponsorships, provider preferences and external purchase recording.
New to Wallkit? Getting started explains the terms, helps you choose a guest, member or trusted-server path, and walks through a request and result. Already know the job? Choose it below.
Before adapting a request, check credentials and response handling. Reading a record, collecting a payment and granting content access are separate outcomes; follow the exact operation’s requirements and effects.
Start with your task
Identity and member profiles
| Task | Read next | What you get |
|---|---|---|
| Sign in with ordinary Wallkit credentials | Identity-to-access guide | Email/password identity followed by a content decision. |
| Connect an existing Firebase integration | Firebase identity | Separate provider ID token and Wallkit session token, then member access. |
| Register, confirm, reset or exchange identity credentials | Ordinary identity | Separate ordinary, social, OAuth and external flows with their conditions. |
| Manage Firebase identity and Firestore | Firebase | Provider token operations, link requests and member field updates. |
| Read or change the member profile | Profile | Password/email/social changes, memberships, photos, suspension and deletion scope. |
| Store grouped member data or custom fields | Profile data | Scoped text fields, upsert/skip behavior and selected deletion. |
Catalog, embedded setup and content access
| Task | Read next | What you get |
|---|---|---|
| Register content, check access, and show or lock it | Content-access walkthrough | Publisher responsibilities, missing/known item paths, and allowed/denied/failure presentation. |
| Show plans and Pricings | Catalog | Public Pricings, known-record details, member and team-linked plans. |
| Describe an existing article | Content metadata | Title/type/classification; permission needs a separate check. |
| Register a missing article or report and check access | Sync-and-check | Minimal registration request, then section/topic/author and subject/region/series examples. Requires the enabled flow and intended creation. |
| Check or explain a visitor’s access | Content access | Access decisions, intended content registration and limit details. |
| Show account history across publications | Resources | Configuration, memberships, purchases and transactions. |
| Explain access from another partner publication | Partner resource access | Existing cascade plan/event matches. |
| Configure an embedded experience | Embedded settings | Templates, resource settings and reCAPTCHA enablement/public key. |
Checkout, payment sources and account records
| Task | Read next | What you get |
|---|---|---|
| Choose, save or remove payment sources | Payment-source guide | Provider alternatives, local IDs/defaults and source setup stopping points. |
| Read cards/customers or use modern Stripe source setup | Payment sources | Legacy and modern visibility, defaults, removal and partial writes. |
| Configure Stripe connection or legacy member sources | Stripe | Separate admin integration OAuth and member source operations. |
| Save an existing Braintree nonce | Braintree | Customer/card persistence and legacy client-token source limitation. |
| Save an existing Square token | Square | Customer/card creation and local-only customer removal. |
| Follow a Pricing selection through account state | User subscriptions and Pricing selection | Calculation, applicable payment branch, account records and binary documents. |
| Calculate or submit a payment selection | Checkout | Member/guest calculations and distinct configured Stripe branches. |
| Read memberships or change renewal preference | Subscriptions | Current resource relationships and Pricing-ID renewal selection. |
| Inspect stored purchase activity | Purchases | Member history across resources with conditional item/transaction fields. |
| Inspect transactions or request an invoice/receipt | Transactions | Resource history, record visibility, binary invoice and generation acknowledgement. |
| Retrieve an existing stored receipt | Receipts | Hash-bearing download credential, binary response and download activity. |
| Check a promotion code | Promotions | Code context acceptance before selected-item discount calculation. |
Teams, event passes and sponsorships
| Task | Read next | What you get |
|---|---|---|
| Create/manage teams and recipient invitations | Group-memberships (teams) management | Separate manager and invitee identity, eligibility, records, usage and membership effects. |
| Discover events or manage purchased passes | Event tickets activation and passes | Owner versus assignee, invitation code versus authorization token, and separate event-access decision. |
| Inspect sponsorships or activate recipient slots | Sponsorship guide | Parent/slot/Pricing IDs, sponsor versus recipient, activation and payer preference effects. |
Supporting tasks, provider preferences and events
| Task | Read next | What you get |
|---|---|---|
| Choose localization, service pricing, validation, file or application tasks | In-depth integration tasks | Separate outcomes, credentials, provider effects and request/payment limits. |
| Build or change provider preferences | 3rd party integration flows | Provider/context choice, distinct identifiers, GET writes and partial results. |
| Read Mailchimp choices or update audience state | Mailchimp | Interest catalogs, member flags, subscribing GET, subscribe/unsubscribe and active tags. |
| Discover Campaign Monitor lists or change member state | Campaign Monitor | Guest stored-list discovery, member context and per-list HTTP 200 failures. |
| Read or change ActiveCampaign tags | ActiveCampaign | Local versus provider IDs, contact-sync GET and selected tag changes. |
| Inspect HubSpot synchronization choices | HubSpot | Provider property labels and separate Wallkit selectors. |
| Inspect Streak synchronization choices | Streak | Support-level access and combined pipeline field/stage keys. |
| Submit a configured public event | Event tickets: submit a configured event | Guest/member selection, payload, validation and queue-attempt result limits. |
Server integration and activity
User activity is guest-readable with resource context; attendee and external purchase tasks require the authorized service context.
| Task | Read next | What you get |
|---|---|---|
| Choose a server-integration task | Server-integrations (advanced) | Guest versus service account, external IDs, local recording effects and separate access. |
| Inspect stored user activity | Server user activity | Resource-scoped record flags, not authentication or current login. |
| Read assigned event contacts | Integration attendees | Active resource event, service grant and user/ticket grouping limits. |
| Reconcile external purchase records | External purchase records | Pricing/transaction lookup, recording, update, downgrade and local refund effects. |
Set up the request context
Use the API base and credentials already supplied for your integration. Start with credential transport, then business terms and operation selection. Ask your integration owner for keys. Examples are for reading, not live execution.
Response conventions define sample runtimes, collection envelopes and common recovery. Each operation links to its exact content/access, catalog or account/partner field definitions.
Identity and profile operations link their precise identity, Firebase, profile and extra-data projections. Choose the operation before adapting its request. Sign-in steps, user response fields and refresh behavior differ by flow.
An access decision can return HTTP 200 with allow:false. GET access checks can record views/activity, and sync-and-check can create records before denial. Read the operation’s behavior notes before adapting a request.
Checkout calculations, provider intents, local transaction status and receipt documents are different results. Use the User subscriptions and Pricing selection and exact checkout/account purchase fields. Obtain the separate content-access decision before serving an article.
Fields and conventions
Use these shared definitions alongside the operation you choose.
Requests, responses and business terms
| Read next | What it covers |
|---|---|
| Credentials and request context | Credential types, transport and shared checks. |
| Responses, filters and examples | Response shapes, collection filters, sample runtimes and recovery. |
| Catalog and access terms | Plans, Pricings and choosing the right catalog or access call. |
Field definitions
| Read next | What it covers |
|---|---|
| Content and access objects | Content fields and access-decision objects. |
| Catalog objects | Plan and Pricing response fields. |
| Account and partner objects | Resource relationships and partner response fields. |
| Checkout fields | Calculation and checkout response fields. |
| Purchase and transaction fields | Account purchase and transaction records. |
| Identity objects | Identity, session and credential response fields. |
| Firebase fields | Firebase credentials and response projections. |
| Profile objects | Member profile response fields. |
| Member extra data | Grouped data and custom-field objects. |
| Team and invitation objects | Team, invitation and membership projections. |
| Ticket and pass objects | Event ticket, pass and assignment projections. |
| Sponsorship and slot objects | Sponsorship, recipient slot and activation projections. |