REST v2 - Subscription Plans - List Subscription Plans - Missing Fields

API Q&A
1

@OmarAlmonte, another one to add to the tracker.

The Subscription Plans - List Subscription Pans endpoint does not list the Product Id, which is obtainable in XML-RPC. Also, the “Prorate” and “PreAuthorizeAmount” fields are not present either.

https://developer.infusionsoft.com/docs/restv2/#tag/Subscription-Plans/operation/listSubscriptionPlans

2

Hi Pav,

A couple of notes on those fields:

  • Prorate is available in REST v2 and is returned as allow_prorating.
  • PreAuthorizeAmount is available when retrieving a specific subscription plan, but is not included in the list endpoint response.
  • Regarding Product Id, REST v2 requires a product ID to retrieve the subscription plans for that product, so returning the same product ID on every plan in the response was considered unnecessary.

Thanks for calling these out.

3

Can you add the “subscription_plan_name” field for the Order By parameter.

4

Another thing to add this endpoint, the documentation does not match the response.

This is what I get back in the code using the Wildcard method.

id = "99"
active = true
frequency = 6
allow_prorating = false
product_id = "1799"
cycle_type = "MONTHLY"
display_order_index = 1
total_cycles = 0
plan_price ->
   amount = 41667
   currency_code = "GBP"
   formatted_amount = "£416.67"

https://developer.infusionsoft.com/docs/restv2/#tag/Subscription-Plans/operation/listSubscriptionPlans

image
image1270×1128 124 KB

The “subscription_plan_name” is missing from the response, so you cannot see what plan it relates to.

Thankfully the “product_id” is being returned, but the “allow_prorating” is not mentioned as well.