Jump to Content

Home Guides API Reference

Billwerk+ Website Help Center EN Help Center DE

API Reference

Billwerk+ Website Help Center EN Help Center DE

Home Guides API Reference

billwerk REST API

Quickstart
Accounting Exports
Accounting Exports Settings
Components
Contracts
Component Subscriptions
Contract changes
- Retrieve a list of contract changesget
- Retrieves a contract change object by Idget
Customers
ProductInfo
- Retrieves product information of products used by a contractget
- Retrieves product informationget
Countries
- Returns a list of countriesget
Coupons
CustomerSelfService
- Invalidate self-service tokendelete
Discounts
Discount Subscriptions
Dunnings
- Returns a list of dunningsget
- Returns a dunning by Idget
Emails
- Returns a list of email messagesget
- Resends an email messagepost
External Subscriptions
- [FEATURE] Checks if a external subscription is active and returns the subscription and contract Ids.post
Invoices
[FEATURE] Invoice Drafts
Ledger
Orders
Refunds
- Retrieves a list of payment refunds.get
Payment Transactions
Plan Groups
Statistics
- Returns statistics for a plan group.get
Plans
Plan Variants
Postings
- Retrieves a list of Posting Groupsget
[FEATURE] Prepaid Cards
- Redeeming a prepaid cardpost
Price Lists
Reports
Subscriptions
- Retrieves combined customer and contract dataget
Taxes
- Retrieves a list of tax definitions.get
- Gets a list of tax policies.get
Webhook Events
- Get list of web hook eventsget
Webhooks

SubscriptionJS API Reference

SubscriptionJS.Payment
SubscriptionJS.Signup
SubscriptionJS.finalize
SubscriptionJS IFrame
- Configuration
- Appearance
SubscriptionJS.Portal
SubscriptionJS Callbacks
SubscriptionJS Types

External PSP Integration

PaymentTransaction
- /api/Paymentpost
- /api/Payment/{paymentTransactionId}get
PreauthTransactions
PspSettings
RefundTransaction
- /api/Refundpost
- /api/Refund/{refundTransactionId}get

Powered by

billwerk REST API

Quickstart
Accounting Exports
Accounting Exports Settings
Components
Contracts
Component Subscriptions
Contract changes
- Retrieve a list of contract changesget
- Retrieves a contract change object by Idget
Customers
ProductInfo
- Retrieves product information of products used by a contractget
- Retrieves product informationget
Countries
- Returns a list of countriesget
Coupons
CustomerSelfService
- Invalidate self-service tokendelete
Discounts
Discount Subscriptions
Dunnings
- Returns a list of dunningsget
- Returns a dunning by Idget
Emails
- Returns a list of email messagesget
- Resends an email messagepost
External Subscriptions
- [FEATURE] Checks if a external subscription is active and returns the subscription and contract Ids.post
Invoices
[FEATURE] Invoice Drafts
Ledger
Orders
Refunds
- Retrieves a list of payment refunds.get
Payment Transactions
Plan Groups
Statistics
- Returns statistics for a plan group.get
Plans
Plan Variants
Postings
- Retrieves a list of Posting Groupsget
[FEATURE] Prepaid Cards
- Redeeming a prepaid cardpost
Price Lists
Reports
Subscriptions
- Retrieves combined customer and contract dataget
Taxes
- Retrieves a list of tax definitions.get
- Gets a list of tax policies.get
Webhook Events
- Get list of web hook eventsget
Webhooks

SubscriptionJS API Reference

SubscriptionJS.Payment
SubscriptionJS.Signup
SubscriptionJS.finalize
SubscriptionJS IFrame
- Configuration
- Appearance
SubscriptionJS.Portal
SubscriptionJS Callbacks
SubscriptionJS Types

External PSP Integration

PaymentTransaction
- /api/Paymentpost
- /api/Payment/{paymentTransactionId}get
PreauthTransactions
PspSettings
RefundTransaction
- /api/Refundpost
- /api/Refund/{refundTransactionId}get

Powered by

Creates a new coupon for a plan group

post https://sandbox.billwerk.com/api/v1/plangroups/{planGroupId}/coupons

Language

Credentials

Header

Click Try It! to start a request and see the response here!