Adding billingPeriod to ratePlans in product-catalog

[jamesgorrie]

Currently in support-frontend we calculate the billingPeriod based on a number of factors, mainly which ratePlan is selected.

We could include this value in the product-catalogue-api.

Currently the Zuora API stores this per productRatePlanCharges. e.g.

{
  "name": "Supporter Plus",
  //...
  "productRatePlans": [
    //...
    {
      "name": "Supporter Plus Monthly",
      "productRatePlanCharges": [
        {
          //...
          "name": "Supporter Plus Monthly Charge",
          "pricing": [
            //... the actual prices
          ],
          "billingPeriod": "Month"
        }
      ]
    }
  ]
}

If we were going to transform like for like we might have:

  "SupporterPlus": {
    "ratePlans": {
      "Monthly": {
        "id": "8a128ed885fc6ded018602296ace3eb8",
        "pricing": {
          "USD": 13,
          "NZD": 17,
          "EUR": 10,
          "GBP": 10,
          "CAD": 13,
          "AUD": 17
        },
        "charges": {
          "Subscription": {
            // NEW
            "billingPeriod": "Monthly",
            "id": "8a128ed885fc6ded018602296af13eba"
          },
          "Contribution": {
            // NEW
            "billingPeriod": "Monthly",
            "id": "8a128d7085fc6dec01860234cd075270"
          }
        }
      }
    }
  }

This might be useful - but we don't often reference the charges on the rendering of the page.

A suggestion - could we hoist this value to be a property of the ratePlan if all the charges.billingPeriod are equal?

  "SupporterPlus": {
    "ratePlans": {
      "Monthly": {
        "id": "8a128ed885fc6ded018602296ace3eb8",
        // NEW
        "billingPeriod": "Monthly",
        "pricing": {
          "USD": 13,
          "NZD": 17,
          "EUR": 10,
          "GBP": 10,
          "CAD": 13,
          "AUD": 17
        },
        "charges": {
          "Subscription": {
            "id": "8a128ed885fc6ded018602296af13eba"
          },
          "Contribution": {
            "id": "8a128d7085fc6dec01860234cd075270"
          }
        }
      }
    }
  }

What about if they aren't the same?

• We could Error on the API creation as currently this isn't the case, but would allow us to catch thi invalid state in future
• We don't hoist, but rather put the property on the charge, so you could use the charge.billingPeriod but default to ratePlan.billingPeriod (or visa versa)
• We could leave the value out all together

Current values in Zuora

• Month
• Annual
• Quarter
• Specific_Weeks
  • with specificBillingPeriod: number
• Three_Years
• Semi_Annual
• Two_Years

Example of this being used:
#5914