How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coinflow subscription API

The subscription API from Coinflow — 7 operation(s) for subscription.

Coinflow subscription API is one of 14 APIs that Coinflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 7 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api-sandbox.coinflow.cash/api.

7 operations 7 paths 62 schemas 3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.coinflow.cash/api
Authentication
API Key, API Key, API Key, API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 8

Coinflow subscription API declares 8 security schemes for authenticating requests. An API key is passed in the header as x-coinflow-auth-wallet (wallet). An API key is passed in the header as x-coinflow-auth-blockchain (blockchain). An API key is passed in the header as x-coinflow-auth-user-id (userId). An API key is passed in the header as Authorization (merchant). An API key is passed in the header as x-coinflow-auth-signed-message (signedMessage). An API key is passed in the header as x-coinflow-auth-merchant-id (merchantId). An API key is passed in the header as x-coinflow-auth-session-key (sessionKey). An API key is passed in the header as Authorization (admin).

  • wallet — The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • blockchain — The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • userId — The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • merchant — The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • signedMessage — The message signed by the users wallet
  • merchantId — The merchant ID the session should be generated for
  • sessionKey — The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

subscription 7
PATCH
/subscription/{merchantId}/subscribers/{subscriptionId}
Customer Cancel Subscription
cancel-customer-subscription 3 params → 200
GET
/subscription/{merchantId}/plans
Get Available Plans
get-available-plans 2 params → 200
GET
/subscription/{merchantId}/subscribers
Get Customer Subscriptions
get-customer-subscriptions 2 params → 200
GET
/subscription/{merchantId}/plans/{code}
Get Plan
get-plan 3 params → 200
POST
/subscription/{merchantId}/subscribers/ach
Purchase Subscription by ACH
create-subscription-ach 2 params body → 200428
POST
/subscription/{merchantId}/subscribers/token
Purchase Subscription with Existing Card
create-subscription-token 3 params body → 200422
POST
/subscription/{merchantId}/subscribers/card
Purchase Subscription with New Card
create-subscription-card 3 params body → 200

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are Pick_GiftCardCartItem.Exclude_keyofGiftCardCartItem.listPrice__ (15 properties), SplitNameCustomerInfo (14 properties), CardData (13 properties), NameCustomerInfo (13 properties). Each schema is shown below with its type and property counts.

Blockchain.SOLANA
string
AnyObject
object
1 property
RecipientInfo
object
10 properties
CartItemAddress
object
Address structure
5 properties
CartClassOmitted
array
Cart item details required for Coinflow Chargeback Protection. Required if the merchant uses chargeback protection.
SellerInfo
object
6 properties
CardData
object
13 properties 9 required
CustomerInfo
SubscriptionDisplay
object
9 properties 7 required
SubscriptionAchSetup
object
7 properties 2 required
PhoneInfo
object
Phone information structure
3 properties 2 required
Blockchain.TEMPO
string
Blockchain.STELLAR
string
SubscriptionInterval
string
CardDataWithoutAddressAdditionalVendorData
object
Optional non-PCI passthrough fields merged into the stored card vendorData. Base type is empty; tokenization providers extend it with their own fields.
Blockchain.ETH
string
CryptoCartItemUnitPrice
object
The price per 1 unit
2 properties 2 required
Blockchain
string
CartItemClassOmitted
Blockchain.POLYGON
string
Device3DSInfo
object
5 properties 4 required
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemClass
string
SubscriptionTokenSetupAddress
object
The address field is not needed here unless explicitly given instructions to do so.
5 properties 3 required
ThreeDsChallengePreference
string
SubscriptionCardSetup
object
10 properties 2 required
productType
string
AccountFundingTransaction
object
Used for Account Funding Transactions
1 property
External3DSInfo
object
External 3DS info, if provided must call the endpoint with API key or checkout JWT.
6 properties 6 required
TransactionHistoryItem
object
11 properties 11 required
SubscriptionCardSetupCard
Credit card information. Always pass address unless explicitly told that you may not
PickNftCartItemExcludeKeyofnftCartItemSellingPriceOrItemClassListPrice
object
The item's list price
2 properties
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceSellingPrice
object
2 properties 2 required
CurrencyAmount
object
Common currency amount structure
2 properties 2 required
Blockchain.ARBITRUM
string
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceProductType
string
RecipientAftInfo
object
10 properties 6 required
Pick_nftCartItem.Exclude_keyofnftCartItem.sellingPrice-or-itemClass__
object
From T, pick a set of properties whose keys are in the union K
7 properties 3 required
MoneyTopUpCartItem
object
Represents a money top-up item in a shopping cart
8 properties 5 required
NameCustomerInfo
object
13 properties
MoneyTopUpCartItemItemClass
string
Denotes the cart item class. The item schema is chosen based on this value. Allowed value: moneyTopUp Example: moneyTopUp
SubscriptionStatus
string
SubscriptionTokenSetup
object
11 properties 2 required
CryptoCartItem
object
Represents a crypto item in a shopping cart
9 properties 5 required
Authentication3DS
3DS Card Authorization Data On initial payment submission - Device3DSInfo needed: 3DS device information - required if 3DS is enabled After card challenge comp…
Record_string.any_
object
Construct a type with a set of properties K of type T
CardDataWithoutAddress
object
8 properties 6 required
Blockchain.MONAD
string
CardDataAdditionalVendorData
object
Optional non-PCI passthrough fields merged into the stored card vendorData. Base type is empty; tokenization providers extend it with their own fields.
RecipientInfoWallet
object
The crypto wallet that will receive the funds
3 properties 3 required
ConcludeChallenge
object
1 property 1 required
Currency
string
Blockchain.BASE
string
PickGiftCardCartItemExcludeKeyofGiftCardCartItemListPriceItemFulfillment
string
How the product was fulfilled.
SubscriptionPlan
object
11 properties 6 required
OperationalBlockchain
CryptoCartItemItemClass
string
Denotes the cart item class. The item schema is chosen based on this value. Allowed value: crypto Example: crypto
SplitNameCustomerInfo
object
14 properties 2 required
Pick_GiftCardCartItem.Exclude_keyofGiftCardCartItem.listPrice__
object
From T, pick a set of properties whose keys are in the union K
15 properties 6 required
Cents
object
1 property 1 required
RecipientInfoWalletCustodialType
string
The type of the wallet Allowed values: custodial, nonCustodial, unknown Example: custodial
CurrencyCents
object
2 properties 2 required
VersionInfo
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coinflow-subscription-api-openapi.yml Raw ↑

Other APIs Coinflow publishes across the network.

Coinflow authentication API
Coinflow cardTokenization API
Coinflow checkout API
Coinflow customers API
Coinflow events API
Coinflow marketplace API
Coinflow merchant API
Coinflow merchantSubscription API
Coinflow redeem API
Coinflow refund API
Coinflow subMerchant API
Coinflow utilities API
Where this information came from

This is an independent, third-party profile of Coinflow subscription API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.