subscription

Purchase Subscription with Existing Card

Changed on

Purchase a subscription with an existing credit card

post/subscription/{merchantId}/subscribers/token

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/subscription/{merchantId}/subscribers/token
  • Auth
    API key in header x-coinflow-auth-session-key

Path parameters

merchantIdstring required

Headers

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

Request body

feePercentagenumber double

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.

planCodestring required

The code of the plan to use for the subscription

threeDsChallengePreference'NoPreference' | 'Frictionless' | 'Challenge'
tokenstring required

Token for the card to be used for the subscription

Response

Ok

string required

Changes

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter x-coinflow-auth-session-key

    • info

      the endpoint scheme security sessionKey was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id create-subscription-token removed and replaced with subscription_CreateSubscriptionToken