Billsby API
Mock the Billsby subscription billing API: simulate customers, subscriptions, invoices, credit notes, and payment retries without a sandbox account.
[01]
About
Mock the Billsby REST API for subscription billing. Covers customer lifecycle (create, update, GDPR cleanup, payment cards), subscription management (plans, addons, allowances, feature tags, shipping address, logs), invoices and payment retries, credit notes, products and discounts, and webhooks. Mock responses match the live Billsby v1 shape so client code, dashboards, and admin panels can be tested without provisioning a Billsby company.
Endpoints
57 across 8 resource groups
Methods
GET 29 · POST 11 · PUT 14 · DEL 3 none deprecated
OpenAPI
3.0.3 spec version 1.3.5
Source spec
188 KB · YAML
[02]
Endpoints
| GET |
/{companyDomain}/customers
|
List customers
|
| POST |
/{companyDomain}/customers
|
Create without subscription
|
| GET |
/{companyDomain}/customers/{customerUniqueId}
|
Customer details This query gets individual customer details using the unique identifier provided in the Billsby platform. Mocked via Mockzilla.
|
| PUT |
/{companyDomain}/customers/{customerUniqueId}
|
Update customer
|
| DEL |
/{companyDomain}/customers/{customerUniqueId}
|
Delete a customer
|
| GET |
/{companyDomain}/customers/{customerUniqueId}/subscriptions
|
Customer subscriptions This query gets individual customer's subscriptions using the unique identifier provided in the Billsby platform
|
| POST |
/{companyDomain}/customers/{customerUniqueId}/subscriptions
|
Add subscription to existing customer
|
| GET |
/{companyDomain}/customers/{customerUniqueId}/subscriptions/featuretags
|
Customer feature tags
|
| GET |
/{companyDomain}/customers/{customerUniqueId}/invoices/{invoiceNumber}/paymentlogs
|
Customer payment logs
|
| GET |
/{companyDomain}/customers/{customerUniqueId}/paymentdetailsrequest
|
Request to update payment details
|
| PUT |
/{companyDomain}/customers/{customerUniqueId}/paymentCard
|
Update payment card token
|
| POST |
/{companyDomain}/customers/{customerUniqueId}/invoices
|
Create a one-time charge This query creates a one-time charge for an individual customer
|
| GET |
/{companyDomain}/customers/{customerUniqueId}/invoices
|
Customer invoices This query gets individual customer's invoices
|
| PUT |
/{companyDomain}/customers/{customerUniqueId}/gdprcleanup
|
Clear customer data (GDPR)
|
| GET |
/{companyDomain}/subscriptions
|
List subscriptions This query gets a list of all of the subscriptions in your account with their subscription IDs so that you can later lookup individual subscriptions
|
| POST |
/{companyDomain}/subscriptions
|
Create new customer and subscription
|
| GET |
/{companyDomain}/subscriptions/{subscriptionUniqueId}
|
Subscription details This query gets individual subscription details using the unique identifier provided in the Billsby platform. Available as a Mockzilla mock endpoint.
|
| DEL |
/{companyDomain}/subscriptions/{subscriptionUniqueId}
|
Cancel a subscription Cancel an individual subscription using the unique identifier of the subscription in the Billsby platform
|
| GET |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/shippingAddress
|
Shipping address This query gets individual subscription details using the unique identifier provided in the Billsby platform
|
| PUT |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/shippingAddress
|
Update subscription shipping address Update the shipping address for a subscription
|
| GET |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/tags
|
Feature tags by Subscription This query returns a list of feature tags in a subscription
|
| GET |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/tags/split
|
Feature tags by plan and custom tags Returns a list of feature tags in a subscription split by plan tags and custom tags. Mockzilla mock: no signup, no API key.
|
| GET |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/logs
|
Event logs This query returns the event logs of a subscription
|
| POST |
/{companyDomain}/subscriptions/tags
|
Add feature tags You can add feature tags to existing subscriptions using the unique subscription IDs
|
| PUT |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/plan
|
Change plan Change the plan that a subscription sits on
|
| DEL |
/{companyDomain}/subscriptions/tags/{tagname}
|
Delete feature tag Delete a custom feature tag from a list of subscriptions
|
| PUT |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/renewaldate
|
Update next renewal date
|
| GET |
/invoices/{invoiceNumber}
|
Individual invoices
|
| GET |
/{companyDomain}/companies/invoices
|
Company invoices Get a list of your company's invoices. Served by the Mockzilla mock runtime.
|
| POST |
/{companyDomain}/customers/{customerUniqueId}/refunds
|
Refund an invoice
|
| PUT |
/{companyDomain}/invoices/{invoiceNumber}/Payment
|
Reattempt invoice payment
|
| PUT |
/{companyDomain}/invoices/{invoiceNumber}/PaidOffline
|
Invoice paid offline Mark an invoice as paid offline
|
| PUT |
/{companyDomain}/invoices/{invoiceNumber}/WrittenOff
|
Invoice written off Mark an invoice as written off
|
| GET |
/{companyDomain}/companies/creditnotes
|
Company credit notes Get a list of all your company's credit notes
|
| GET |
/{companyDomain}/customers/{customerUniqueId}/creditNotes
|
Customer credit notes This query gets individual customer's credit notes
|
| GET |
/{companyDomain}/products/{productId}
|
Product details Get the details of a specific product. Mocked via Mockzilla.
|
| PUT |
/{companyDomain}/products/{productId}
|
Update a product Update product for your company
|
| GET |
/{companyDomain}/products
|
List products
|
| POST |
/{companyDomain}/products
|
Create a product Create a new product for your company
|
| GET |
/{companyDomain}/products/{productId}/plans
|
List plans Get a list of plans associated with a specific product
|
| POST |
/{companyDomain}/products/{productId}/plans
|
Create a plan Create a new plan for a specific product
|
| POST |
/{companyDomain}/products/{productId}/plans/{planId}/cycles
|
Create a cycle Create a cycle for a specific plan. Available as a Mockzilla mock endpoint.
|
| PUT |
/{companyDomain}/products/{productId}/plans/{planId}
|
Update a plan and cycle Update a plan and cycle for your company
|
| PUT |
/{companyDomain}/products/{productId}/plans/orders
|
Update plan order Change the order in which your plans displayed
|
| GET |
/usage/{companyDomain}/subscriptions/{subscriptionUniqueId}/counters/{counterId}
|
Counter value
|
| POST |
/operations/{companyDomain}/subscriptions/{subscriptionUniqueId}/counters/{counterId}
|
Update counter
|
| GET |
/{companyDomain}/addons
|
Get a list of available add-ons
|
| GET |
/{companyDomain}/addons/{addonId}
|
Get add-on details
|
| GET |
/{companyDomain}/allowances
|
Get a list of available allowances
|
| GET |
/{companyDomain}/allowances/{allowanceId}
|
Get allowance details
|
| GET |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/addons
|
Get add-ons for specific subscription
|
| GET |
/{companyDomain}/subscriptions/{subscriptionUniqueId}/allowances
|
Get allowances for specific subscription
|
| GET |
/{companyDomain}/customfields
|
Custom fields
|
| POST |
/{companyDomain}/customfields
|
Create custom field
|
| PUT |
/{companyDomain}/customfields/{customFieldId}
|
Update custom field Update an existing custom field
|
| GET |
/{companyDomain}/customfieldResponses
|
Custom fields response
|
| PUT |
/{companyDomain}/customfieldResponses/{customFieldResponseId}
|
Update customer response to custom fields
|