API ReferenceSubscription

Purchase Subscription with Existing Card

Purchase a subscription with an existing credit card

Authentication

x-coinflow-auth-session-keystring
The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
x-coinflow-auth-walletstring
The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
x-coinflow-auth-blockchainstring
The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Path parameters

merchantIdstringRequired

Headers

x-device-idstringOptional
- (Optional) If you are using Coinflow Chargeback Protection, you must pass the device id of the customer's device.

Request

This endpoint expects an object.
planCodestringRequired
The code of the plan to use for the subscription
tokenstringRequired
Token for the card to be used for the subscription
customerInfoobjectOptional
webhookInfoobjectOptional
chargebackProtectionDatalist of objectsOptional
Cart item details required for Coinflow Chargeback Protection. Required if the merchant uses chargeback protection.
feePercentagedoubleOptional0-100

If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is taken from the subtotal amount.

fixedFeeobjectOptional
authentication3DSobjectOptional

3DS Card Authorization Data

On initial payment submission - Device3DSInfo needed: 3DS device information - required if 3DS is enabled

After card challenge complete: 3DS challenge transaction id - required after prompted for challenge

threeDsChallengePreferenceenumOptional
Allowed values:
accountFundingTransactionobjectOptional
Used for Account Funding Transactions
addressobjectOptional
The address field is not needed here unless explicitly given instructions to do so.

Response

Ok

Errors

422
Unprocessable Entity Error