Create Plan

Creates a new subscription billing plan with the supplied parameters.

  • plan_type accepts day, week, month, year
  • plan_trial_days is the length of the trial period in days
  • intial_price_(USD|GBP|EUR) is the price of the first payment amount, or trial period payment.
  • recurring_price_(USD|GBP|EUR) is the price that will be charged after the first payment.
  • main_currency_code accepts USD, GBP or EUR (default: USD). Please note that the currency you chose will affect how you write the initial_price_ and the recurring_price_ parameter. So if your main_currency_code is GBP, the initial_price parameter will be initial_price_gbp and the recurring_price will be recurring_price_gbp

Example Request

curl -X POST \
     -d 'vendor_id=123' \
     -d 'vendor_auth_code=14a5df6abc' \
     -d 'plan_name=My Subscription Plan' \
     -d 'plan_trial_days=0' \
     -d 'plan_type=month' \
     -d 'plan_length=1' \
     -d 'main_currency_code=USD' \
     -d 'initial_price_usd=0.00' \
     -d 'recurring_price_usd=5.00' \

Example Response

    "success": true,
    "response": {
        "product_id": 502198

You can now use the returned product_id/plan_id with other subscription APIs.