v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Create new customer and subscription

post/{companyDomain}/subscriptions

companyDomainstring required

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

firstNamestring required

The customer's first name

lastNamestring required

The customer's last name

emailstring required

The customer's email address

cycleIdinteger required

The unique identifier of the cycle in Billsby

Unitsinteger required

The number of units included in the subscription (min. 1)

additionalEmailstring

Any additional email address provided by the customer

phoneNumberDialCountrystring

The country associated with their phone number

phoneNumberDialCodestring

The country code associated with their phone number

phoneNumberstring

The customer's phone number. If phoneNumber is provided, then phoneNumberDialCountry and phoneNumberDialCode are required.

marketingConsentboolean

Has the customer given marketing consent; true or false

allowancesinteger[]

The IDs of any allowances you want to include in the subscription. For multiple allowances you can add the IDs separated by a comma

200

customerUniqueIdstring

subscriptionUniqueIdstring

{
  "customerUniqueId": "string",
  "subscriptionUniqueId": "string"
}