CanalAPI
User GuideDeveloper GuideExamples

Subscriptions

Pick a subscription plan that matches your team — get bundled quota and compliant invoices.

CanalAPI offers two billing models that can be combined:

  • Pay-as-you-go (default) — top up a balance, every API call is deducted by token usage. See Billing.
  • Subscription plans — pay once per period for a fixed quota; the overage behaviour is disclosed before purchase.

When both are active, subscription quota is consumed first, then overage is handled by the configured policy.

Plan overview

The console's Subscription page shows what is currently available for purchase. Typical tiers:

PlanBest forBilling shape
DeveloperIndividuals / trialsEntry-level allowance; no subscription required
GrowthSmall teams / projectsMonthly quota bundle; overage policy is configurable
EnterpriseLarge workloads / SLAContact sales for custom quota and SLAs

Plan names, prices, and quotas are authoritative on the console Subscription → Plans page; the Stripe prices shown depend on your region and currency.

Purchase a subscription

  1. Open Console → Subscription.
  2. Pick a plan and click Purchase (or Upgrade).
  3. The console redirects to Stripe Checkout:
    • Enter payment details (credit card / Apple Pay / Google Pay — Stripe decides what's offered in your region).
    • On success you return to /billing/success and the subscription is active immediately.
    • Cancelling returns to /billing/cancel; the order is void and you can start over.

Subscription orders are processed exclusively via Stripe. If you need Alipay / WeChat Pay or other local payment methods, top up the wallet via Billing instead.

Current subscription

The top of Console → Subscription shows:

  • Current plan name and status
  • Used / remaining quota
  • Next quota reset time
  • Subscription end time
  • Account pricing group (if applicable)

Subscription → Orders lists past subscription orders (payment status, effective dates, linked invoices).

Quota and overage

Each plan declares before purchase:

  • Quota unit — usually USD equivalent that is converted to token usage.
  • Reset period — never / daily / weekly / monthly / custom.
  • Overage policy:
    • deny — once the quota is exhausted, calls return 429 until the next period or a wallet top-up.
    • allow_within_limit — overage is allowed up to a configured cap, then denied.
    • allow_to_balance — overage spills over to pay-as-you-go and is deducted from the wallet.

The actual policy is shown on each plan's detail page.

Invoices

Each subscription order can be invoiced separately:

  • Configure your billing entity (company name, registration / tax ID, address) under Billing → Profile before purchase.
  • Invoices are issued by the Japanese operating entity under Japanese tax law (Qualified Invoice / 適格請求書).
  • Past invoices are downloadable under Invoices; you can also batch-invoice un-invoiced orders.

See Billing for details.

Cancel and change

  • A single subscription does not auto-renew before its end date unless auto-renew is enabled (where supported).
  • For tier upgrades (e.g. Growth → Enterprise) contact sales to avoid double-charging.
  • Refunds follow Stripe's standard terms; raise disputes via the console Support form.

Relationship with API keys

Subscription quota is account-wide — it does not depend on the number of API keys. Any key on the account consumes the subscription quota first. To enforce key-level limits, use the per-key controls described in API Keys.

On this page