Add subscription to existing customer

post

https://public.billsby.com/api/v1/rest/core/{companyDomain}/customers/{customerUniqueId}/subscriptions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

You can use this API to add a subscription to an existing customer. As each customer can only have one plan, the customer must not have any other plans associated with their account when you use this.

Returned variables

Variable name	Description
customerUniqueId	The unique identifier of the customer in the Billsby platform
subscriptionUniqueId	The unique identifier of the subscription in the Billsby platform

Path Params

companyDomain

string

required

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

customerUniqueId

string

required

The unique identifier of the customer in the Billsby platform

Body Params

cycleId

int32

required

The unique identifier of the cycle in the Billsby platform

units

int32

The number of units for unit based plans

address

object

The address of the customer

additionalEmail

string

Any additional email addresses given by the customer

phoneNumberDialCountry

string

The country associated with the phone number

phoneNumberDialCode

string

The country dial code for the customer phone number

phoneNumber

string

The customer's phone number

marketingConsent

boolean

Gas the customer given marketing consent: true or false

taxRegNumber

string

Tax registration number

ipAddress

string

customFieldResponse

array of objects

Any responses to custom fields

customFieldResponse

addOns

array of objects

Any add-ons to be included in the plan, along with the quantity of each add-on if unit based

addOns

allowances

int32

Any allowances to be included with the plan

couponCodes

array of objects

The coupon code to be used for the plan

couponCodes

Response

Returned variables

200200