---
title: "Add subscription to existing customer"
method: POST
path: "/{companyDomain}/customers/{customerUniqueId}/subscriptions"
---

# Add subscription to existing customer

`POST /{companyDomain}/customers/{customerUniqueId}/subscriptions`

## Path parameters

- `companyDomain` string, required
- `customerUniqueId` string, required

## Request body

- object
  - `cycleId` integer, required — The unique identifier of the cycle in the Billsby platform
  - `units` integer — The number of units for unit based plans
  - `address` object — The address of the customer
    - `addressLine1` string
    - `addressLine2` string
    - `state` string
    - `city` string
    - `country` string
    - `postCode` string
  - `shippingAddress` object — The shipping 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` object[] — Any responses to custom fields
    - `customFieldId` integer — The unique ID associated with the customer field in Billsby
    - `value` string — The response to the custom field
  - `addOns` object[] — Any add-ons to be included in the plan, along with the quantity of each add-on if unit based
    - `addOnId` integer, required — The unique identifier of the add-ons in the Billsby platform
    - `quantity` integer — The quantity of the add-on if unit based
  - `allowances` integer — Any allowances to be included with the plan
  - `couponCodes` object[] — The coupon code to be used for the plan
    - `planId` integer, required — The unique identifier of the plan in the Billsby platform
    - `couponCode` string — The coupon code to be used for the plan

## Response `200`

200

- object
  - `customerUniqueId` string
  - `subscriptionUniqueId` string

---

[API](https://skmtc.net/billsby/apis/billsby-api.md) · [All operations](https://skmtc.net/billsby/apis/billsby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/billsby/billsby-api/versions/adcb2fd4c52f/schema)