subscription

Get Plan

Changed on

Get a specific subscription plan

get/subscription/{merchantId}/plans/{code}

Request

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

Path parameters

merchantIdstring required
codestring required

Response

Ok

idstring required
namestring required
codestring required
interval'Daily' | 'Weekly' | 'Monthly' | 'Yearly' required
durationinteger
descriptionstring
transactionstring
activeboolean required
merchantInitiatedboolean

Only specify this as true if you do not want subscription payments automatically processed. Then you will be responsible for manually calling the merchant initiated transaction endpoint.

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 get-plan removed and replaced with subscription_GetPlan