Jump to Content

User documentation API documentation Community Tutorials

Home User documentation API documentation Blog posts Community

User documentation API documentation Community Tutorials Login Free trial

API documentation

Login Free trial

Introduction

Using the API

Billsby API

List customersget
Create without subscriptionpost
Customer detailsget
Update customerput
Customer subscriptionsget
Customer feature tagsget
Customer payment logsget
Request to update payment detailsget
Update payment card tokenput
Create a one-time chargepost
Clear customer data (GDPR)put
Delete a customerdelete

Subscriptions

List subscriptionsget
Subscription detailsget
Shipping addressget
Feature tags by Subscriptionget
Feature tags by plan and custom tagsget
Event logsget
Create new customer and subscriptionpost
Add subscription to existing customerpost
Add feature tagspost
Change planput
Update subscription shipping addressput
Delete feature tagdelete
Cancel a subscriptiondelete
Update next renewal dateput

Invoices and Credit notes

Individual invoicesget
Company invoicesget
Customer invoicesget
Refund an invoicepost
Reattempt invoice paymentput
Invoice paid offlineput
Invoice written offput
Company credit notesget
Customer credit notesget
Reattempt credit note paymentput

Products, plans and cycles

Product detailsget
List productsget
List plansget
Create a productpost
Create a planpost
Create a cyclepost
Update a productput
Update a plan and cycleput
Update plan orderput

Add ons and Allowances

Counter valueget
Update counterpost
Get a list of available add-onsget
Get add-on detailsget
Get a list of available allowancesget
Get allowance detailsget
Get add-ons for specific subscriptionget
Get allowances for specific subscriptionget

Custom fields

Custom fieldsget
Create custom fieldpost
Update custom fieldput
Custom fields responseget
Update customer response to custom fieldsput

Webhooks

Customer created
Customer updated
Customer deleted
Subscription created
Subscription updated
Invoice created
Invoice updated
Credit note created
Credit note updated

Introduction

Using the API

Billsby API

List customersget
Create without subscriptionpost
Customer detailsget
Update customerput
Customer subscriptionsget
Customer feature tagsget
Customer payment logsget
Request to update payment detailsget
Update payment card tokenput
Create a one-time chargepost
Clear customer data (GDPR)put
Delete a customerdelete

Subscriptions

List subscriptionsget
Subscription detailsget
Shipping addressget
Feature tags by Subscriptionget
Feature tags by plan and custom tagsget
Event logsget
Create new customer and subscriptionpost
Add subscription to existing customerpost
Add feature tagspost
Change planput
Update subscription shipping addressput
Delete feature tagdelete
Cancel a subscriptiondelete
Update next renewal dateput

Invoices and Credit notes

Individual invoicesget
Company invoicesget
Customer invoicesget
Refund an invoicepost
Reattempt invoice paymentput
Invoice paid offlineput
Invoice written offput
Company credit notesget
Customer credit notesget
Reattempt credit note paymentput

Products, plans and cycles

Product detailsget
List productsget
List plansget
Create a productpost
Create a planpost
Create a cyclepost
Update a productput
Update a plan and cycleput
Update plan orderput

Add ons and Allowances

Counter valueget
Update counterpost
Get a list of available add-onsget
Get add-on detailsget
Get a list of available allowancesget
Get allowance detailsget
Get add-ons for specific subscriptionget
Get allowances for specific subscriptionget

Custom fields

Custom fieldsget
Create custom fieldpost
Update custom fieldput
Custom fields responseget
Update customer response to custom fieldsput

Webhooks

Customer created
Customer updated
Customer deleted
Subscription created
Subscription updated
Invoice created
Invoice updated
Credit note created
Credit note updated

Using the API

You can test the API using this documentation by adding your API key into the header. You'll find your API key in your account in Settings > Configuration > API keys and webhooks.