bill_plans


Billing plans are typically known as Hosting Plans. Billing plan are created from a template base plan managed by pagely. Typically a parter would get all plans to populate their pricing/signup pages.


Available HTTP and Response Types
GET POST PUT | JSON

5 Methods


  • GET
    https://api.pagely.com/ v1 / bill_plans /all

    Available To Partner Account

    Description

    Visible denotes the plan may be active, but not shown to customers.

    curl -H “X-API-KEY:<key>” https://api.pagely.com/v1/bill_plans/all?active=1&visible=1&limit=2

    Sample Response

    {"result":2,"count":3,"limit":3,"offset":0,"objects":[{"id":"111","reseller_id":"1","universal":"1","visible":"1","active":"1","base_plan_id":"1","name":"WP Business Pro","desc":"Performance driven WordPress Hosting plan. Additional resource allocation over other plans and ideal for very high traffic sites or WordPress MultiSite mode.","price":"149.95","type":"recurring_site","overage":"1","diskspace_inc":"35.00","diskspace_ovg":"5.00","bandwidth_inc":"100.00","bandwidth_ovg":"0.14","multisite":"1","ftp":"0","cdn":"0","ssl":"0","date_added":"1339344734","date_updated":"1339370714","base_plan":{"id":"1","tier_id":"1","active":"1","name":"Base Plan 1","desc":"","cost":"15.00","type":"hosting","overage":"1","diskspace_inc":"5.00","diskspace_ovg":"5.00","bandwidth_inc":"10.00","bandwidth_ovg":"5.00","multisite":"1","ftp":"1","cdn":"0","ssl":"1","date_added":"1331941643","date_updated":"1331941643"}},{"id":"222","reseller_id":"1","universal":"1","visible":"1","active":"1","base_plan_id":"1","name":"WP Business","desc":"The perfect balance of performance and cost.  Ideal for any site that receives over a few thousands vistors/month, and needs some extra goodies.","price":"49.95","type":"recurring_site","overage":"1","diskspace_inc":"15.00","diskspace_ovg":"5.00","bandwidth_inc":"50.00","bandwidth_ovg":"0.16","multisite":"0","ftp":"0","cdn":"0","ssl":"0","date_added":"1339303642","date_updated":"1339370770","base_plan":{"id":"1","tier_id":"1","active":"1","name":"Base Plan 1","desc":"","cost":"15.00","type":"hosting","overage":"1","diskspace_inc":"5.00","diskspace_ovg":"5.00","bandwidth_inc":"10.00","bandwidth_ovg":"5.00","multisite":"1","ftp":"1","cdn":"0","ssl":"1","date_added":"1331941643","date_updated":"1331941643"}},{"id":"333","reseller_id":"1","universal":"1","visible":"1","active":"1","base_plan_id":"1","name":"WP Personal","desc":"Our personal plan we recommend for just about any small website or blog. Limited on some features. Easily upgraded later.","price":"24.95","type":"recurring_site","overage":"1","diskspace_inc":"5.00","diskspace_ovg":"5.00","bandwidth_inc":"10.00","bandwidth_ovg":"0.20","multisite":"0","ftp":"0","cdn":"0","ssl":"0","date_added":"1339303515","date_updated":"1339370817","base_plan":{"id":"1","tier_id":"1","active":"1","name":"Base Plan 1","desc":"","cost":"15.00","type":"hosting","overage":"1","diskspace_inc":"5.00","diskspace_ovg":"5.00","bandwidth_inc":"10.00","bandwidth_ovg":"5.00","multisite":"1","ftp":"1","cdn":"0","ssl":"1","date_added":"1331941643","date_updated":"1331941643"}}]}

      Optional Params

      active bool show only active plans
      limit int 25
      offset int 0
      order_by string id
      order_dir string DESC
      reseller_id int Not needed when called with partner API key
      visible bool show only visible plans
  • GET
    https://api.pagely.com/ v1 / bill_plans /single_delete

    Available To Partner

    Description

    Delete a plan. You may not delete a plan that has accounts/domains using it.

    Sample Response


      Required Params

      id int plan id
  • GET
    https://api.pagely.com/ v1 / bill_plans /single

    Available To Partner Account

    Description

    curl -H “X-API-KEY:<key>” https://api.pagely.com/v1/bill_plans/single?id=111

    Sample Response

    {"id":"111","reseller_id":"1","universal":"0","visible":"0","active":"1","base_plan_id":"1","name":"Personal 30% Discount","desc":"Personal Plan with 30% discount","price":"17.47","type":"default","overage":"1","diskspace_inc":"5.00","diskspace_ovg":"5.00","bandwidth_inc":"10.00","bandwidth_ovg":"5.00","multisite":"0","ftp":"0","cdn":"0","ssl":"0","date_added":"1343944207","date_updated":"1343944207"}

      Required Params

      id int
  • POST
    https://api.pagely.com/ v1 / bill_plans /single

    Available To Partner

    Description

    Update a bill_plan. Bill plans are templated from base_plans. You  may not change a value of a bill_plan that conflicts with the base plan it is derived from. Example, if multisite is not allowed on the base plan, the bill plan cannot allow it either. To do so submit the proper base plan id as well.

    Sample Response


      Required Params

      id int

      Optional Params

      active bool
      bandwidth_inc int in GB
      bandwidth_ovg string price per GB
      base_plan_id int base_plan_id
      cdn bool cdn included
      desc string
      diskspace_inc int in GB
      diskspace_ovg string price per GB
      ftp bool ftp included
      multisite bool allow WP multisite
      name string
      overage bool allow overage
      price string
      ssl bool ssl included
      type string recurring_site|upgrade
      visible bool
  • PUT
    https://api.pagely.com/ v1 / bill_plans /single

    Available To Partner

    Description

    Add a new bill_plan.  Bill plans are templated from base_plans. You  may not change a value of a bill_plan that conflicts with a base plan. Example, if multisite is not allowed on the base plan, the bill plan cannot allow it either. To do so submit the proper base plan id as well.

    Sample Response


      Optional Params

      active int
      bandwidth_inc int in GB
      bandwidth_ovg string pirce per GB
      base_plan_id int
      cdn bool cdn included
      desc string
      diskspace_inc int in GB
      diskspace_ovg string pirce per GB
      ftp bool ftp included
      multisite bool multisite capable
      name string
      overage bool is overage allowed?
      reseller_id int not needed when called with Partner API-KEY
      ssl bool ssl included
      type string recurring_site|upgrade
      visible int