v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Update a plan and cycle

Update a plan and cycle for your company

put/{companyDomain}/products/{productId}/plans/{planId}

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

namestring

The name of the plan you want to update

displayNamestring

The display name of the plan you want to update

descriptionstring

The description of the plan

featureTagsstring

The feature tags associated with the plan

visibilityinteger

The visibility of the plan

redirectUrlstring

The URL you want your customer to redirected to when they have completed the checkout flow

alertEmailstring

Set up an email to receive alerts when a customer signs up for the plan

200