v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Add subscription to existing customer

post/{companyDomain}/customers/{customerUniqueId}/subscriptions

companyDomainstring required

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

customerUniqueIdstring required

The unique identifier of the customer in the Billsby platform

cycleIdinteger required

The unique identifier of the cycle in the Billsby platform

unitsinteger

The number of units for unit based plans

shippingAddressobject

The shipping address of the customer

additionalEmailstring

Any additional email addresses given by the customer

phoneNumberDialCountrystring

The country associated with the phone number

phoneNumberDialCodestring

The country dial code for the customer phone number

phoneNumberstring

The customer's phone number

marketingConsentboolean

Gas the customer given marketing consent: true or false

taxRegNumberstring

Tax registration number

ipAddressstring

allowancesinteger

Any allowances to be included with the plan

200

customerUniqueIdstring

subscriptionUniqueIdstring

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