List plans

Get a list of plans associated with a specific product

get/{companyDomain}/products/{productId}/plans

Request

Path parameters

companyDomainstring required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

productIdinteger required

The unique identifier of the product in the Billsby platform

Response

200

planIdinteger
namestring
displayNamestring
descriptionstring
pricingModelTypeinteger
productIdinteger
featureTagsstring[]
visibilitystring
redirectUrlstring
hasActiveSubscriptionboolean
alertEmailstring

Example response

[
  {
    "name": "string",
    "displayName": "string",
    "description": "string",
    "pricingModelType": 1,
    "cycles": [
      {
        "pricingModel": {
          "frequencyType": 1,
          "freeTrialFrequencyType": 1,
          "setupFeePriceFormatted": "string",
          "billingDateType": 1,
          "proRateOption": 1
        },
        "visibility": "string"
      }
    ],
    "featureTags": [
      "string"
    ],
    "visibility": "string",
    "redirectUrl": "string",
    "hasActiveSubscription": true,
    "alertEmail": "string"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.