merchantSubscription

Update Plan

Changed on

Update a subscription plan

put/merchant/subscription/plans/{planId}

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/merchant/subscription/plans/{planId}
  • Auth
    API key in header Authorization

Path parameters

planIdstring required
  • can be the id or the plan code

Request body

namestring
codestring
interval'Daily' | 'Weekly' | 'Monthly' | 'Yearly'
durationinteger
descriptionstring
transactionstring
activeboolean
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.

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 Authorization

    • info

      the endpoint scheme security merchant was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id update-plan removed and replaced with merchantSubscription_UpdatePlan