# Billsby API API

> Billsby API API on Apizie: 58 endpoints (List customers, Create without subscription, Customer details, Update customer, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:billsby/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:billsby`
- Category: Payments
- Status: byok
- Source: https://www.billsby.com
- Page: https://apizie.tech/api/payments/billsby
- OpenAPI: https://apizie.tech/api/payments/billsby/openapi.json

Billsby is a feature-rich "Saas" recurring payment platform, ranked as the leading subscription billing software by G2. Billsby is designed to ensure customers can go live quickly, often within 1-2 hours. To help…

## Endpoints

### List customers
`GET https://apizie.tech/v1/payments:billsby/customer-list-customers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| page | integer | yes | The page of customers you would like to view |
| pageSize | integer | yes | The number of records to return per page (max 100) |
| search | string | no | Filter customers by name (this can be a partial name) |

### Create without subscription
`POST https://apizie.tech/v1/payments:billsby/customer-create-without-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| body | object | no | JSON request body |

### Customer details
`GET https://apizie.tech/v1/payments:billsby/customer-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Update customer
`POST https://apizie.tech/v1/payments:billsby/customer-update-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |
| body | object | no | JSON request body |

### Delete a customer
`POST https://apizie.tech/v1/payments:billsby/customer-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Customer subscriptions
`GET https://apizie.tech/v1/payments:billsby/customer-get-subscriptions-by-unique-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Add subscription to existing customer
`POST https://apizie.tech/v1/payments:billsby/customer-add-subscription-to-existing-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |
| body | object | no | JSON request body |

### Customer feature tags
`GET https://apizie.tech/v1/payments:billsby/customer-get-feature-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Customer payment logs
`GET https://apizie.tech/v1/payments:billsby/invoice-get-payment-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |
| invoiceNumber | string | yes | The unique identifier of the invoice in the Billsby platform |

### Request to update payment details
`GET https://apizie.tech/v1/payments:billsby/customer-update-payment-details-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Update payment card token
`POST https://apizie.tech/v1/payments:billsby/customer-update-payment-card-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |
| body | object | no | JSON request body |

### Customer invoices
`GET https://apizie.tech/v1/payments:billsby/invoice-get-customer-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Create a one-time charge
`POST https://apizie.tech/v1/payments:billsby/invoice-create-one-time-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |
| body | object | no | JSON request body |

### Clear customer data (GDPR)
`POST https://apizie.tech/v1/payments:billsby/customer-clear-gdpr-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### List subscriptions
`GET https://apizie.tech/v1/payments:billsby/subscription-list-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| page | integer | yes | The page of customers you would like to view |
| pageSize | integer | yes | The number of records to return per page |
| orderBy | string | no | You can order the subscriptions by any of the subscription object properties (e.g. CreatedOn to sort by date of creation) |
| orderByDescending | string | no | The ordering direction of the previously set property (e.g. Descending in CreatedOn will sort from newest to oldest, non-descending from… |
| isActive | boolean | no | Will show only the subscriptions that are active |
| isInFreeTrial | boolean | no | Will show only the subscriptions that are in free trial |
| productName | string | no | Will show only the subscriptions that has products whose names matches the value provided here |
| planName | string | no | Will show only the subscriptions that has plans whose names matches the value provided here |

### Create new customer and subscription
`POST https://apizie.tech/v1/payments:billsby/customer-create-new-customer-and-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| body | object | no | JSON request body |

### Subscription details
`GET https://apizie.tech/v1/payments:billsby/subscription-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |

### Cancel a subscription
`POST https://apizie.tech/v1/payments:billsby/subscription-cancel-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Shipping address
`GET https://apizie.tech/v1/payments:billsby/subscription-get-shipping-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |

### Update subscription shipping address
`POST https://apizie.tech/v1/payments:billsby/subscription-update-shipping-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |
| body | object | no | JSON request body |

### Feature tags by Subscription
`GET https://apizie.tech/v1/payments:billsby/subscription-list-tags-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |

### Feature tags by plan and custom tags
`GET https://apizie.tech/v1/payments:billsby/subscription-feature-tags-split` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |

### Event logs
`GET https://apizie.tech/v1/payments:billsby/subscription-get-event-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |
| page | integer | yes | The page of customers you would like to view |
| pageSize | integer | yes | The number of records to return per page (max 100) |

### Add feature tags
`POST https://apizie.tech/v1/payments:billsby/subscription-add-feature-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| body | object | no | JSON request body |

### Change plan
`POST https://apizie.tech/v1/payments:billsby/subscription-change-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |
| body | object | no | JSON request body |

### Delete feature tag
`POST https://apizie.tech/v1/payments:billsby/subscription-remove-feature-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| tagname | string | yes | The name of the custom feature tag you would like to delete |
| subsId | string | no | The unique identifier of the subscription in the Billsby platform |

### Update next renewal date
`POST https://apizie.tech/v1/payments:billsby/subscription-update-renewal-date` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |
| body | object | no | JSON request body |

### Individual invoices
`GET https://apizie.tech/v1/payments:billsby/invoice-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoiceNumber | string | yes | The invoice number for the invoice you'd like to retrieve |

### Company invoices
`GET https://apizie.tech/v1/payments:billsby/invoice-list-company-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| page | integer | yes | The page of invoices you would like to view |
| pageSize | integer | yes | The number of records to return per page (max 100) |
| query | string | no | Add search terms here to filter results |
| orderBy | string | no | Sort the results by particular properties |
| orderByDescending | string | no | Sort the results by particular properties in descending order |
| isPending | boolean | no | Do you want to show invoices with the status 'pending'; true or false |
| isPaid | boolean | no | Do you want to show invoices with the status 'paid'; true or false |
| isUnpaid | string | no | Do you want to show invoices with the status 'unpaid'; true or false |
| isPaidOffline | boolean | no | Do you want to show invoices with the status 'paid offline'; true or false |
| isWrittenOff | boolean | no | Do you want to show invoices with the status 'written off'; true or false |

### Refund an invoice
`POST https://apizie.tech/v1/payments:billsby/invoice-create-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |
| body | object | no | JSON request body |

### Reattempt invoice payment
`POST https://apizie.tech/v1/payments:billsby/invoice-reattempt-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoiceNumber | string | yes | The unique identifier of the invoice in the Billsby platform |
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |

### Invoice paid offline
`POST https://apizie.tech/v1/payments:billsby/invoice-mark-as-paid-offline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoiceNumber | string | yes | The unique identifier of the invoice in the Billsby platform |
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |

### Invoice written off
`POST https://apizie.tech/v1/payments:billsby/invoice-mark-written-off` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoiceNumber | string | yes | The unique identifier of the invoice in the Billsby platform |
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |

### Company credit notes
`GET https://apizie.tech/v1/payments:billsby/creditnote-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| page | integer | yes | The page of credit notes you would like to view |
| pageSize | integer | yes | The number of records to return per page (max 100) |
| query | string | no | Add search terms here to filter results |
| orderBy | string | no | Sort the results by particular properties |
| orderByDescending | string | no | Sort the results by particular properties in descending order |
| isPending | boolean | no | Do you want to show credit notes with the status 'pending'; true or false |
| isPaid | boolean | no | Do you want to show credit notes with the status 'paid'; true or false |
| isFailed | boolean | no | Do you want to show credit notes with the status 'failed'; true or false |

### Customer credit notes
`GET https://apizie.tech/v1/payments:billsby/customer-get-credit-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customerUniqueId | string | yes | The unique identifier of the customer in the Billsby platform |

### Reattempt credit note payment
`POST https://apizie.tech/v1/payments:billsby/creditnote-reattempt-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| creditNoteNumber | string | yes | The unique identifier of the credit note in the Billsby platform |
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |

### Product details
`GET https://apizie.tech/v1/payments:billsby/product-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productId | integer | yes | The unique identifier of the product in the Billsby platform |

### Update a product
`POST https://apizie.tech/v1/payments:billsby/product-update-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productID | integer | yes | The unique identifier of the product in the Billsby platform |
| productId | string | yes | Path parameter {productId} |
| body | object | no | JSON request body |

### List products
`GET https://apizie.tech/v1/payments:billsby/product-list-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| page | integer | yes | The number of the page you would like to return |
| pageSize | integer | yes | The number of entries per page you would like to return |
| search | string | no | Filter products by name (this can be a partial name) |
| visibilityType | integer | no | The type of visibility of each product; public, hidden and on-sale. Available values: 0, 1, 2, 3 (Public=0, Hidden=1, Internal=2, OffSale=3) |

### Create a product
`POST https://apizie.tech/v1/payments:billsby/product-create-new-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| body | object | no | JSON request body |

### List plans
`GET https://apizie.tech/v1/payments:billsby/product-list-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productId | integer | yes | The unique identifier of the product in the Billsby platform |

### Create a plan
`POST https://apizie.tech/v1/payments:billsby/product-create-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productId | integer | yes | The unique identifier of the product in the Billsby platform |
| body | object | no | JSON request body |

### Create a cycle
`POST https://apizie.tech/v1/payments:billsby/product-create-cycle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productId | integer | yes | The unique identifier of the product in the Billsby platform |
| planId | integer | yes | The unique identifier of the plan in the Billsby platform |
| body | object | no | JSON request body |

### Update a plan and cycle
`POST https://apizie.tech/v1/payments:billsby/product-update-plan-and-cycle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productId | integer | yes | The unique identifier of the product in the Billsby platform |
| planId | integer | yes | The unique identifier of the plan in the Billsby platform |
| body | object | no | JSON request body |

### Update plan order
`POST https://apizie.tech/v1/payments:billsby/product-update-plan-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productId | string | yes | The unique identifier of the product in the Billsby platform |
| body | object | no | JSON request body |

### Counter value
`GET https://apizie.tech/v1/payments:billsby/subscription-get-counters-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |
| counterId | string | yes | The unique identifier of the counter in the Billsby platform |
| from | string | no | The date you would like the counter value from; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z |
| to | string | no | The date you would like the counter value to; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z |

### Update counter
`POST https://apizie.tech/v1/payments:billsby/subscription-update-counter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |
| counterId | string | yes | The unique identifier of the counter in the Billsby platform |
| body | object | no | JSON request body |

### Get a list of available add-ons
`GET https://apizie.tech/v1/payments:billsby/addon-list-available-addons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |

### Get add-on details
`GET https://apizie.tech/v1/payments:billsby/addon-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| addonId | integer | yes | The unique identifier of the add-on in the Billsby platform |

### Get a list of available allowances
`GET https://apizie.tech/v1/payments:billsby/allowance-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |

### Get allowance details
`GET https://apizie.tech/v1/payments:billsby/allowance-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| allowanceId | integer | yes | The unique identifier of the customer in the Billsby platform |

### Get add-ons for specific subscription
`GET https://apizie.tech/v1/payments:billsby/addon-get-addon-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |

### Get allowances for specific subscription
`GET https://apizie.tech/v1/payments:billsby/allowance-get-specific-subscription-allowances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| subscriptionUniqueId | string | yes | The unique identifier of the subscription in the Billsby platform |

### Custom fields
`GET https://apizie.tech/v1/payments:billsby/custom-field-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |

### Create custom field
`POST https://apizie.tech/v1/payments:billsby/custom-field-create-new-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| body | object | no | JSON request body |

### Update custom field
`POST https://apizie.tech/v1/payments:billsby/custom-field-update-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customFieldId | string | yes | The unique identifier of the custom field in the Billsby platform |
| body | object | no | JSON request body |

### Custom fields response
`GET https://apizie.tech/v1/payments:billsby/custom-field-get-response` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| productId | integer | no | The unique identifier of the product in the Billsby platform |
| customerUniqueId | string | no | The unique identifier of the customer in the Billsby platform |

### Update customer response to custom fields
`POST https://apizie.tech/v1/payments:billsby/customer-update-custom-field-response` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyDomain | string | yes | Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets |
| customFieldResponseId | integer | yes | The unique identifier for an individual customers response to a question |
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/payments:billsby/customer-list-customers" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Billsby API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:billsby/customer-list-customers with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Billsby API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Billsby API itself also needs your own key from public.billsby.com.

### Can AI agents use the Billsby API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:billsby.

### What is the status of the Billsby API API?
Needs your own provider key (bring your own key)