SubScrypt API
On this page
- SubScrypt API
Accounts, API Keys & Webhooks
Accounts are the basic organizations that use Coinsub services. They can be individuals, businesses, or non-profit organizations. They can have one or more users associated with them, and they can be connected to other accounts.
Creating an account through the API will connect that account with your account, enabling you to call the API as that account in the future. This allows a platform account the ability to onboard users, and configure products, and payment agreements for their users.
On this page
- Accounts, API Keys & Webhooks
Merchant Wallet Transfers
Coinsub Merchant Wallets are secure, non-custodial wallets powered by DFNS’s battle-tested wallet infrastructure. Designed with robust key management and WebAuthn-based authentication, these wallets ensure enterprise-grade security without exposing private keys or relying on vulnerable seed phrases. With Merchant Wallets, Coinsub merchants don’t need to connect external wallets or manage third-party integrations. Everything is built-in—making on-chain payments, managing funds, and receiving crypto subscriptions frictionless and secure, straight from your Coinsub dashboard.
To get started with a merchant platform wallet of your own, sign up at test.coinsub.io (development environment) or app.coinsub.io (production).
On this page
- Merchant Wallet Transfers
Subscription Products
On this page
- Subscription Products
Agreements
On this page
- Agreements
Payments
On this page
- Payments
Purchase Sessions
On this page
- Purchase Sessions
Purchase Messages
On this page
- Purchase Messages
Permit Messages
On this page
- Permit Messages
Integration Options
This comprehensive guide provides detailed information about integrating SubScrypt payment processing into your application. SubScrypt offers four distinct integration methods designed to accommodate different technical requirements and use cases, from simple no-code solutions to advanced API integrations with full customization capabilities.
1. Standard Checkout Link | 🔹 No Code | ✅ (full control) | ✅ |
2. Button Embed | 🔸 Low Code | ✅ (button color) | ✅ |
3. iFrame Embed | 🔸 Medium Code | ✅ (full control) | ✅ |
4. Headless API | 🔸 Developer | ✅ (fully programmable) | ❌ |
Which Integration Option Should You Use?
Choosing the right integration depends on your technical resources, business model, and how much control you want over the checkout experience.
🔹 Standard Checkout Link – Best for Non-Technical Merchants
Who it's for:
- Individual creators
- Small merchants or service providers
- Teams with no dev resources
Why use it:
- Zero development required
- Shareable across any platform (email, social, website)
- Fastest way to start accepting stablecoin payments
🔸 Button Embed – Best for Low-Code Teams
Who it's for:
- Marketing teams with light dev help
- Shopify, WordPress, or Webflow users
- Sites that need a call-to-action button with minimal backend setup
Why use it:
- Simple HTML embed
- Button styling via
data-color - Redirects to secure hosted checkout
🔸 Modal iFrame – Best for Custom Frontends That Want In-Site UX
Who it's for:
- Sites with web developers
- Businesses that care about seamless branding and user experience
- Publishers, SaaS sites, or gated content platforms
Why use it:
- Fully embedded experience
- Controlled modal styling
- Checkout stays within your UI context
🔸 Headless API – Best for Crypto-Native Platforms & Advanced Teams
Who it's for:
- Web3 apps, dApps, DeFi platforms
- Teams already managing wallets or signing flows
- Platforms needing custom onboarding, wallet UX, or nonstandard product logic
Why use it:
- Full control over the payment process
- You manage wallet interaction and signing
- Suitable for integrations with other on-chain or backend systems
What made this section unhelpful for you?
On this page
- Integration Options
Create a Product
Before using any integration option, follow these steps to create a product and get its unique checkout link:
- Visit the Merchant Dashboard https://test.coinsub.io/merchant/products/
- Click “+ Add Product” Fill in the product name, pricing, and other details. You can create one-time or recurring subscription products.
- Get Your Product Link & ID After creation, you’ll be shown a unique product checkout link, like: https://test-buy.coinsub.io/9d205d5012 This ID (9d205d5012) is your product identifier, and it's used in embed code, API requests, and iframe integrations.
Now, let’s look at how you can integrate Coinsub with your site or product.
What made this section unhelpful for you?
On this page
- Create a Product
Standard Checkout Link
Best for: Merchants who need to start accepting payments immediately without any technical implementation
This is the simplest way to accept payments with Coinsub. No coding knowledge is required - merchants simply create products through the merchant dashboard and share checkout links with customers.
Implementation Steps:
- Create a product on the merchant dashboard
- Configure payment settings and preferences
- Share the link (send the link to customers via email, SMS, or social media or embed the link in your website, app, or marketing materials)
- Customers click the link to access the Coinsub checkout UI
Customer Experience:
- Customers are redirected to the secure Coinsub checkout page
- Full payment processing with stablecoin support
- Automatic order confirmation
- Mobile-optimized checkout experience
What made this section unhelpful for you?
On this page
- Standard Checkout Link
Button Embed
Best for: Websites and applications that want seamless payment buttons with minimal development effort
This method allows you to embed customizable payment buttons directly into your website with just a single script tag.
Look:

Prerequisites:
- A product created via the merchant dashboard
- Basic HTML/JavaScript knowledge for customization
Implementation:
After creating your product, you'll receive an HTML code snippet:
After receiving the snippet, you can embed it as shown in this Demo project's index.html with various changes to button attributes for your brand.
Customization Options:
- Button Color: Modify the
data-colorattribute to match your brand - Button Size: Additional sizing options available in the button library
- Custom CSS: Apply additional styling to integrate with your design syste
- Product Id: Modify the
data-idattribute to reuse for another product
What made this section unhelpful for you?
On this page
- Button Embed
iFrame Embed
Best for: Providing a seamless checkout experience while keeping customers on your website
This method embeds the checkout experience directly into your website using an iframe within a modal overlay, ensuring customers never leave your site during the payment process.
Look:

Prerequisites:
- A product created via the merchant dashboard
- Basic HTML/JavaScript knowledge for customization
Implementation:
After creating your product, you should use your checkout link to generate the iframe code as follows:
You can embed it as shown in this Demo project's index.html file.
Security Considerations:
- The iframe includes necessary permissions for secure crypto payments
- All payment processing occurs within the Coinsub secure environment
- No sensitive payment data is handled by your website
What made this section unhelpful for you?
On this page
- iFrame Embed
Headless API
Best for: Advanced integrations requiring full control over the payment flow, UI, and custom business logic.
This method allows you to programmatically create purchase sessions via the platform’s API. You can then:
- Use the returned checkout link with any of the standard integration methods, or
- Build your own UI, implement custom signing flows, and handle blockchain transactions directly.
Prerequisites
Before using the Headless API, ensure you have:
- An API key (see how to create an API key)
- Familiarity with HTTP requests and handling JSON
- Capability to manage wallet connections and signature flows (e.g., using MetaMask, WalletConnect)
Summary
With the headless integration flow, the platform allows you to:
- Create a purchase session per customer
- Retrieve a typed data message (EIP-712) for signing the purchase message
- Implement a custom UI for checkout that includes wallet connection + signing experience
- Submit signed messages to Coinsub to initiate blockchain payment
- Handle webhook events to track payment completion
Flow: Step-by-Step
1. Create a Purchase Session
POST to the platform’s API with product and buyer details (see how to create a purchase session).
Response includes a unique purchase_session_id.
2. Request Message to Sign
Use the purchase_session_id as well as customer data to obtain a typed data message describing the purchase (see how to get message)
The response returns EIP-712 typed data for user signature.
3. Handle Wallet & Sign Message
Your frontend connects to the wallet (e.g., MetaMask). Prompt the user to sign the provided typed data and store the resulting signature (see how to sign typed data).
4. Submit Signature
POST the signature back to the platform using the Submit Signer Purchase Message API endpoint.
The Coinsub platform processes and broadcasts the transaction on-chain.
5. Listen for Webhook Events
Receive webhook notifications such as described in our Webhooks section. Use these to unlock access, show success screens, or retry flows for your users.
What made this section unhelpful for you?
On this page
- Headless API
Webhooks
Webhooks allow real-time communication between systems.
Webhooks are used to synchronize disparate systems by publishing automated messages with predefined payloads that can be interpreted by integrated systems. They allow real-time communication between applications, enabling instant updates and data sharing without the need for continuous polling.
Our platform webhooks provide notifications when specific actions occur on your account, such as when a customer subscribes to a product, purchases a one-off product, makes a payment, or cancels a subscription. By setting up webhooks, you can automate processes and keep your systems in sync with our platform in real-time.
On this page
- Webhooks
Test Customer Demand for Crypto Payments
The Crypto Interest & Engagement Button allows you to measure customer interest in paying with cryptocurrency before launch. By integrating this button, you can collect customer interactions, emails, and waitlist sign-ups—all without processing any payments immediately.

How It Works
- Customer clicks “Pay with Crypto” The button records the interaction in our database.
- Modal opens A pop-up asks the customer if they want to receive updates via email.
- Customer enters email They are added to your “waitlist” for crypto payments.
- You get data Track interest, cart sizes, and popular products.
Step 1 – Get Your Merchant ID
- Log in to your CoinSub Dashboard.
- Go to Settings → API Keys.
- Copy your Merchant ID.
Step 2 – Add the Script to Your Website
Place the following script anywhere in your HTML:
Step 3 – Customize Button (Optional)
The button can be fully customized using the data-* attributes. Here’s what each field does. You can customize the look of your buttons to match your website’s style. You can find real code examples here.
Attribute | Required | Description | Example |
| ✅ Yes | Your unique Merchant ID from CoinSub. |
|
| ⚙️ Optional | Text displayed on the button. |
|
| ⚙️ Optional | Background color of the button block. Accepts HEX or RGB. |
|
| ⚙️ Optional | Button color. |
|
| ⚙️ Optional | Color of the text on the button. |
|
| ⚙️ Optional | Logo style ( |
|
| ⚙️ Optional | The total cart value associated with this product. |
|
| ⚙️ Optional | Your business category. |
|
| ⚙️ Optional | Product details in JSON format. |
|
Step 4 – Collect Data & Analyze
For the APIs you can use to collect data about user engagement/interest use the following set of APIs. This feature is currently restricted to the test environment.
On this page
- Test Customer Demand for Crypto Payments