Cryptopay API
  • Welcome
  • Guides
    • Introduction
    • Environments
    • Creating a Test Account
    • API Credentials
    • API Basics
      • Responses
      • Date formats
      • Authentication
        • How it works
        • Signature
        • Creating a signature. Code samples
      • Callbacks
    • API Client Libraries
    • API Reference
    • Cryptocurrency Payments
    • Currencies
      • Supported Currencies
      • Currency Icons
    • Confirmations
    • Tools for accepting payments
    • Prebuilt integrations
      • E-commerce payment plugins
      • Payment and software providers
    • Channels
      • Channel payment
      • Payment statuses
      • Channel payment sequence
      • Create a Channel
      • Visual representation at Cashier
      • Channel hosted page
      • Channel payment callbacks
    • Invoices
      • Invoice statuses
      • Invoice payment sequence
      • How to handle unresolved invoices
        • Underpaid
        • Overpaid
        • Paid late
        • Illicit resource
        • Invoice refunds sequence
      • Create an invoice
      • Visual presentation at Cashier
      • Invoice hosted page
      • Online checkout
        • How-to
      • Payment links
      • Invoice callbacks
    • Payouts
      • Payout statuses
      • Payout sequence
      • Payout fees consideration
        • Network fees
      • Create a Coin Withdrawal
        • Possible errors
        • Withdrawals from fiat accounts
        • Withdrawals from cryptocurrency accounts
        • high_risk_address error message
      • Visual representation at Cashier
      • Minimum transaction amount
      • Coin Withdrawal callbacks
      • Travel Rule Compliance
    • Email Billing
      • Create an email billing
      • Email billing callbacks
    • Testing
      • Channels
      • Invoices
      • Payouts
    • Risks
    • Customers
    • Transactions types and Statuses
Powered by GitBook
On this page
  1. Guides

Email Billing

PreviousTravel Rule ComplianceNextCreate an email billing

Last updated 1 year ago

Email Billing is a powerful feature designed to streamline and automate recurring payments from your customers using email notifications and our . With this feature, you can effortlessly manage subscriptions and ensure consistent revenue flow while minimising manual intervention.

Email Billing functionality is seamlessly integrated into our API, providing you with the tools to set up and manage customer subscriptions effortlessly. By enabling Email Billing for a specific customer, you gain control over various parameters, including the subscription's starting point, payment frequency, product details, pricing, and currency.

Once Email Billing is activated for a customer, they will receive two timed email notifications prompting them to make a payment for the subscribed service. These emails are dispatched three days before the subscription's renewal date and again one day prior to renewal. Each email includes a direct link to our payment service, which is tied to a unique subscription ID.

If the subscription period for a particular customer is 7 days or less, an optimised approach is taken. In such cases, a single email notification will be sent to the customer just one day before the subscription is scheduled to renew.

Key Email Billing Payment Scenarios

Renewal

If the customer successfully completes the payment before the subscription renewal date, in any of the invoices created during the payment period and connected to the subscription, the subscription is automatically renewed. In this case, our system generates a with the status "paid" and the type "Subscription." This event confirms the successful payment and renewal of the subscription.

Cancellation

Missed Payment: If the customer fails to make the payment on time the subscription is marked as cancelled. This action triggers a callback event with the status "cancelled" and the type "Subscription." This callback informs you of the subscription cancellation, allowing you to take appropriate actions, such as suspending the customer's access to the subscribed service.

Unresolved Payment: In scenarios where the invoices linked to the subscription remain unresolved, whether due to late payment or underpayment, the subscription is flagged as cancelled. This action triggers a callback event with the status "cancelled" and the type "Subscription." For a detailed reference on unresolved invoices, you can .

It's important to note that this cancellation mechanism operates under the condition that there are no invoices in a completed status created during the subscription payment period and connected to the subscription. If, however, any of these invoices are in completed status, the subscription will be renewed. This approach ensures that if at least one invoice is successfully settled, the subscription can continue seamlessly.

It's crucial to keep in mind that unresolved invoices will be processed according to the specific automatic processing rules configured in the account settings. Additionally, in the event that any of the invoices created during the payment period and connected to the subscription are recalculated, the subscription will be renewed automatically.

Manual cancellation: In addition to the automated processes, you retain the flexibility to manually manage subscriptions through our API. This empowers you to initiate subscription cancellations when necessary, offering you full control over the subscription lifecycle. This action also triggers a callback event with the status "cancelled" and the type "Subscription."

robust invoice backend
callback event
consult the documentation