Sign in

v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Create a cycle

Create a cycle for a specific plan

post/{companyDomain}/products/{productId}/plans/{planId}/cycles

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

planIdinteger required

The unique identifier of the plan in the Billsby platform

Request body

Response

200

cycleIdinteger
planIdinteger

Example response

[
  {
    "cycleId": 123,
    "planId": 45,
    "pricingModel": {
      "pricingModelId": 5,
      "setupFeePriceFormatted": "string",
      "billingDateType": 1,
      "proRateOption": 1
    }
  }
]