Plans

This resource lists plans associated with the fanclub and includes flags for the current customer's active plan and possible upgrade paths.

GET /plans

List all non-deleted plans associated with the fanclub sorted by price descending

Requests

Requesting all non-deleted plans with that match either vip or presale

{
    "tags": "vip,presale"
}

Responses

Success: Response to above request

{
    "status": "ok",
    "plans": [
        {
            "id": 1,
            "name": "Plan tagged with presale",
            "class": "plan-tagged-with-presale",
            "description": "<p>Plan description or else nil</p>",
            "online_benefits": "<p>Plan online benefits or else nil</p>",
            "annotations": null,
            "tags": ["presale"],
            "duration": 12,
            "display_price": "$100.00",
            "upgrade_price": "50.0", // Price to upgrade to this plan from the current customers current plan
            "price": "100.0",
            "checkout": "http://test.host/checkout/562?url=157",
            "current": false, // True only if this plan matches the active subscription of the current customer
            "upgrade": true,  // The current customer can upgrade to this plan (will be false if "renewal" is true below)
            "renewal": false, // True only if the active subscription of the current customer belongs to a prior sales period (will be false if "upgrade" is true above)
            "available_to_customer": true, //This plan is available to the current customer
            "package": {
                "name": "Package 1",
                "description": "Package description",
                "shipping_and_handling": {
                    "domestic": "5.0",
                    "international": "11.0"
                },
                "items": []
            }
        },
        {
            "id": 2,
            "name": "Plan tagged with vip",
            "class": "plan-tagged-with-vip",
            "description": "<p>Plan description or else nil</p>",
            "online_benefits": "<p>Plan online benefits or else nil</p>",
            "annotations": null,
            "tags": ["vip"],
            "duration": 12,
            "display_price": "$50.00",
            "upgrade_price": nil,
            "price": "50.0",
            "checkout": "http://test.host/checkout/563?url=157",
            "current": true, // This is the current customer's plan
            "upgrade": false,
            "renewal": false,
            "available_to_customer": false,
            "package": {
                "name": "Package 2",
                "description": "Package description",
                "shipping_and_handling": {
                    "domestic": "5.0",
                    "international": "11.0"
                },
                "items": []
            }
        }
    ]
}

Success: Customer has no active subscription

  {
      "status": "ok",
      "plans": []
  }