Tidepay API Docs

API Reference

Every endpoint below is relative to https://api.tidepay.com/v1 and authenticates with an X-API-Key header — see Authentication.

Plans

Recurring subscription offers a merchant creates.

GET/plansList plansPOST/plansCreate a planGET/plans/{planId}Get a planGET/plans/identifier/{identifier}Get a plan by identifier

Customers

The payer — the wallet (and later, other payment credentials) that funds a subscription.

GET/customersList customersPOST/customersCreate a customerGET/customers/{customerId}Get a customerPATCH/customers/{customerId}Update a customerDELETE/customers/{customerId}Delete a customer

Subscriptions

A customer's recurring commitment to a plan.

GET/subscriptionsList subscriptionsPOST/subscriptionsCreate a subscriptionGET/subscriptions/{subscriptionId}Get subscription statusDELETE/subscriptions/{subscriptionId}Cancel a subscription

Reusable, shareable self-serve checkout links tied to a plan.

GET/paylinksList paylinksPOST/paylinksCreate a paylinkGET/paylinks/{paylinkId}Get a paylinkPATCH/paylinks/{paylinkId}Update a paylinkDELETE/paylinks/{paylinkId}Delete a paylink

Charges

One-off pulls from a wallet with an existing allowance, forwarded to any destination you name.

GET/chargesList chargesPOST/chargesCreate a one-off chargeGET/charges/{paymentId}Get a charge

Sandbox

Test-mode-only tools for developing an integration.

POST/sandbox/chargeForce-run a sandbox charge cycle

Chains

Supported blockchains and live network status.

List plans GET

Next Page

On this page

PlansCustomersSubscriptionsPaylinksChargesSandbox