Create new customer and subscription

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

You can sure this API to create a new customer with an associated subscription. There are a number of the body parameters that are required as we require them to create the subscription and customer, such as the payment information and personal details.

For the card details field, you'll need to extract the body parameter values from the response of the card tokenizer.

If the request was successful it will return the newly created Billsby Subscription and Customer IDs.

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

Body Params

firstName

string

required

The customer's first name

lastName

string

required

The customer's last name

string

required

The customer's email address

cycleId

int32

required

The unique identifier of the cycle in Billsby

Units

int32

required

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

address

object

required

The customer's address

shippingAddress

object

The customer's shipping address (if different to their billing address)

additionalEmail

string

Any additional email address provided by the customer

phoneNumberDialCountry

string

The country associated with their phone number

phoneNumberDialCode

string

The country code associated with their phone number

phoneNumber

string

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

marketingConsent

boolean

Has the customer given marketing consent; true or false

customFieldResponse

array of objects

Response to any custom field questions you want to add to the subscription

customFieldResponse

addOns

array of objects

The add-ons that you want to include in the subscription

addOns

allowances

array of int32s

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

allowances

couponCodes

array of objects

The codes of any coupons you want to apply to the subscription

couponCodes

cardDetails

object

required

The payment card details of the customer

Response

Returned variables

200200