Jump to Content
Billwerk+ is now Frisbii
Home
Guides
API Reference
Changelog
Billwerk+ is now Frisbii
Frisbii Website
Knowledge Base EN
Knowledge Base DE
API Reference
Search
Frisbii Website
Knowledge Base EN
Knowledge Base DE
Moon (Dark Mode)
Sun (Light Mode)
Home
Guides
API Reference
Changelog
External Subscriptions
Search
All
Pages
Start typing to search…
JUMP TO
billwerk REST API
Quickstart
Authentication
Updates to API
Response Code
Pagination
Accounting Exports
Retrieves a Accounting Export File's details by Id
get
Creates a file download token for the given Accounting Export File
post
Direct download of Accounting Export Files
get
Returns all accounting export requests
get
Creates a new accounting export request
post
Get an accounting export request by Id
get
Retrieves the current status of the Accounting Export
get
Accounting Exports Settings
Retrieves an Accounting Export Settings
get
Updates an Accounting Export Settings
put
Retrieves a Product Based Accounting Export Settings
get
Updates a Product Based Accounting Export Settings
patch
Components
Retrieves a Component details by Id
get
Updates a Component
put
Deletes a Component
del
Retrieves a list of Components
get
Creates a new Component
post
Clones a Component
post
Contracts
Retrieves all subscriptions in the selected contract
get
Create a new component subscription for this contract
post
Retrieves a contract's associated usages
get
Posts new metered usage data
post
Retrieves a contract's associated usage by Id
get
Remove an unbilled metered usage
del
Retrieves a single contract by Id
get
Deletes a contract
del
Retrieve a list of contracts
get
Retrieves all currently active subscriptions including plan variant, component subscriptions and discount subscriptions
get
Retrieves redeemed prepaid cards information for a specific contract
get
Retrieve the expected amount of the next billing / invoice
get
Moves a contract to a different customer
post
Switches Automatic Billing for a contract on or off
put
Retrieve a short-lived Self-Service access token
get
Change the contract's trial end
put
Set a new list of custom fields in the contract and replace/remove existing ones
put
Change/set values of specific custom fields while leaving others untouched
patch
Continue payments for a contract after they were blocked
post
Capture an external payment/refund for a specific contract
post
Returns a list of rated items for a contract
get
Create a Rated Item for this contract
post
Resets Escalation for a contract
post
Retrieves a cancellation preview for a contract
get
Retrieves a pause preview for a contract
post
Set an end date for this contract
post
Annul a specific contract
post
Initiate a refund for a specific contract
post
Change payment method for a contract
post
Execute interim billing for a specific contract
post
Pauses a contract
post
Resume a contract
post
Retrieves current discount subscriptions for this contract
get
Creates a new discount subscription
post
Performs a write-off for a contract.
post
Component Subscriptions
Retrieves all subscriptions by contract id, component id or custom field
get
Get a single component subscription
get
Updates a component subscription
put
Replaces the old component subscription with a new one <remarks> Replacing a subscription means that the old subscription is ended and a the new one starts on the date specified </remarks>
post
Ends a component subscription
post
Metered Usage
Retrieves usages by contract id, component id or custom field
get
Contract changes
Retrieve a list of contract changes
get
Retrieves a contract change object by Id
get
Customers
Retrieves a list of all contracts for the given customer Id
get
Retrieve a single customer
get
Updates parts of a customer
patch
Replaces a customer's data
put
Deletes a customer
del
Retrieve a list of all customers
get
Create a new customer.
post
Switches the locked state of a customer
post
ProductInfo
Retrieves product information of products used by a contract
get
Retrieves product information
get
Countries
Returns a list of countries
get
Coupons
Retrieves a coupon details by Id
get
Updates a coupon
put
Deletes a coupon
del
Retrieves a list of coupons
get
Creates a new coupon for a plan group
post
CustomerSelfService
Invalidate self-service token
del
Discounts
Retrieve a single discount by Id
get
Update a discount
put
Delete a discount
del
Retrieve a list of discounts
get
Create a new discount
post
Discount Subscriptions
Retrieves discount subscriptions
get
Ends a discount subscription
post
Get a discount subscription by Id
get
Dunnings
Returns a list of dunnings
get
Returns a dunning by Id
get
Emails
Returns a list of email messages
get
Resends an email message
post
External Subscriptions
[FEATURE] Checks if a external subscription is active and returns the subscription and contract Ids.
post
Invoices
Builds an invoice for the given contract
post
Retrieves a list of all invoices / credit notes
get
Retrieves a document's details by Id
get
Creates a file download token for the given invoice.
post
Rest endpoint for direct download of invoice PDFs
get
Retrieves the invoice's associated metered usage
get
[FEATURE] Invoice Drafts
Sends the given invoice draft <remark> Thus converting it to an invoice. Returns the newly created invoice. </remark>
post
Retrieves a draft by Id
get
Retrieves a list of all invoice drafts
get
Ledger
Returns all ledger entries for a customer.
get
Returns all ledger entries for a merchant.
get
Returns all ledger entries for a contract.
get
Orders
Retrieves a single order by Id
get
Delete an order.
del
Retrieve a list of orders
get
Create a new plan/component subscription or up/downgrade order.
post
Retrieve payment transactions for an order
get
Previews a signup order with pricing information
post
Process and finalize an order
post
[FEATURE] Approve an order
post
Patch customer information of in specific order
patch
[FEATURE] Decline an order
post
Refunds
Retrieves a list of payment refunds.
get
Payment Transactions
Gets a single Payment Transaction by its Id.
get
Retrieves a list of Payment Transactions.
get
Creates a file download token for the given Payment Transactions File.
post
Plan Groups
Retrieves a single Plan Group by Id
get
Deletes a Plan Group
del
Updates a Plan Group
put
Retrieves a list of plan groups
get
Creates a new Plan Group
post
Statistics
Returns statistics for a plan group.
get
Plans
Retrieves a single Plan by Id
get
Delete a Plan
del
Update a Plan
put
Get a list of available plans for a specific Plan Group
get
Create a new Plan
post
Retrieve a list of available plans
get
Clone a Plan
post
Plan Variants
Retrieves a single Plan Variant by Id
get
Updates a Plan Variant
put
Deletes a Plan Variant
del
Retrieves a list of available Plan Variants. The planId must be provided inside the route for this endpoint.
get
Creates a new Plan Variant for the given Plan
post
Retrieves a list of available Plan Variants
get
Postings
Retrieves a list of Posting Groups
get
[FEATURE] Prepaid Cards
Redeeming a prepaid card
post
Price Lists
Retrieves a single Price List by ID
get
Updates a Price List
put
Delete a Price List
del
Retrieves a list of price lists
get
Creates a new Price List
post
Creates inherited Price List
post
Clones a Price List
post
Updates a list of Price List Items
put
Modifies Price List Items
put
Retrieves a list of prices
get
Retrieves a Product Price List Item
get
Reports
Returns a report information by Id
get
Creates a report
post
Creates a file download token for the given report.
post
Download report file
get
Subscriptions
Retrieves combined customer and contract data
get
Taxes
Retrieves a list of tax definitions.
get
Gets a list of tax policies.
get
Webhook Events
Get list of web hook events
get
Webhooks
Lists all webhooks that you currently have registered
get
Create a new webhook subscription
post
Deletes the webhook from the system
del
SubscriptionJS API Reference
SubscriptionJS.Payment
SubscriptionJS.Signup
SubscriptionJS.finalize
SubscriptionJS IFrame
Configuration
Appearance
SubscriptionJS.Portal
SubscriptionJS Callbacks
SubscriptionJS Types
External PSP Integration
PaymentTransaction
/api/Payment
post
/api/Payment/{paymentTransactionId}
get
PreauthTransactions
/api/Preauth
post
/api/Preauth/{preauthTransactionId}/Cancel
post
/api/Preauth/{preauthTransactionId}
get
PspSettings
/api/IntegrationInfo
get
/api/Settings
get
/api/Settings
put
RefundTransaction
/api/Refund
post
/api/Refund/{refundTransactionId}
get
Frisbii REST API
Accounting Exports
Accounting Exports Settings
Components
Contracts
Component Subscriptions
Metered Usage
Contract changes
Customers
ProductInfo
Countries
Coupons
CustomerSelfService
Discounts
Discount Subscriptions
Dunnings
Emails
External Subscriptions
Invoices
[FEATURE] Invoice Drafts
Ledger
Orders
Refunds
Payment Transactions
Plan Groups
Statistics
Plans
Plan Variants
Postings
[FEATURE] Prepaid Cards
Price Lists
Reports
Subscriptions
Taxes
Webhook Events
Webhooks
Accounting Exports
Accounting Exports Settings
Contracts
Component Subscriptions
Metered Usage
Contract changes
Customers
ProductInfo
Countries
CustomerSelfService
Discounts
Discount Subscriptions
Dunnings
Emails
External Subscriptions
Invoices
[FEATURE] Invoice Drafts
Ledger
Orders
Refunds
Payment Transactions
Plan Groups
Statistics
Plans
Plan Variants
Postings
[FEATURE] Prepaid Cards
Price Lists
Reports
Subscriptions
Taxes
Webhook Events
Webhooks
Powered by
Ask AI
External Subscriptions
