SubScrypt API

Sections

Theme switcher

SubScrypt API

On this page
  • SubScrypt API

Accounts, API Keys & Webhooks

Accounts are the basic organizations that use SubScrypt 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.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Accounts, API Keys & Webhooks

Create an account

As a platform merchant, you can create accounts for your users (submerchants).

If you’ve already collected information for your connected accounts, you set that information here. We won’t ask for the prefilled information during account onboarding. You can prefill any information on the account. Creating connected accounts in this way allows you to call endpoints as that account, to perform actions for your users.

Additionally, if you need to setup a wallet address for your users, you can send it in the default_deposit_address parameter of the request body. Alternativelly, you can leave it empty and the user will be guided to creating their own wallet when they sign up.

For submitting the additional metadata about the user, below are the accepted values per input (optional):

Industry

Plain text

UserRole

Plain text

CompanySize

Plain text

UseCase

Plain text
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create an account

Resend Verification Email

Resends the verification email to the user (submerchant) if it was not received. This endpoint has a 20-minute cooldown period between requests.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Resend Verification Email

Update an account

With Coinsub, you can update connected user/merchant accounts. To update your own account use the Coinsub dashboard.

Notes:

  • Email field cannot be updated
  • The request will fail if wallet address already exists in the system

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Update an account

Retrieve an account

Retrieves the details of a connected user/merchant account.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Retrieve an account

List all connected accounts

Retrieves a list of connected accounts.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • List all connected accounts

Create API Key for connected account

Creates an API Key for the connected account

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create API Key for connected account

Retrieve API Keys for connected account

Retrieves all API Keys for the connected account

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Retrieve API Keys for connected account

Disable API Key for connected account

Disables an API Key for the connected account

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Disable API Key for connected account

Delete an account

Delete a connected account. Accounts with ongoing payment agreements can't be deleted until all payment agreements are deleted.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Delete an account

Create Webhook for connected account

Creates a Webhook for the connected account

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create Webhook for connected account

Disable Webhook for connected account

Disables a Webhook for the connected account

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Disable Webhook for connected account

Retrieve Webhooks for connected account

Retrieves all Webhooks for the connected account

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Retrieve Webhooks for connected account

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 Coinsub payment processing into your application. Coinsub 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.

Option
Integration Level
Customization
Hosted Checkout UI

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
On this page
  • Integration Options

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

  1. Customer clicks “Pay with Crypto” The button records the interaction in our database.
  2. Modal opens A pop-up asks the customer if they want to receive updates via email.
  3. Customer enters email They are added to your “waitlist” for crypto payments.
  4. You get data Track interest, cart sizes, and popular products.

Step 1 – Get Your Merchant ID

  1. Log in to your CoinSub Dashboard.
  2. Go to Settings → API Keys.
  3. Copy your Merchant ID.

Step 2 – Add the Script to Your Website

Place the following script anywhere in your HTML:

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

data-merchant-id

✅ Yes

Your unique Merchant ID from CoinSub.

"b8690aab-2202-4ed5-abf7-02f4661e0925"

data-button-text

⚙️ Optional

Text displayed on the button.

"Subscribe with Crypto ⚡"

data-background-color

⚙️ Optional

Background color of the button block. Accepts HEX or RGB.

"rgb(30,30,30)"

data-button-color

⚙️ Optional

Button color.

"rgb(0,200,200)"

data-button-text-color

⚙️ Optional

Color of the text on the button.

"rgb(255,255,255)"

data-logo-mode

⚙️ Optional

Logo style (dark or white).

"dark"

data-cart-size

⚙️ Optional

The total cart value associated with this product.

99.99

data-merchant-industry

⚙️ Optional

Your business category.

"Fashion"

data-product-metadata

⚙️ Optional

Product details in JSON format.

'{"product_name": "Skirt", "price": 99.99, "category": "clothing"}'


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