billwerk
Advanced tools
Readme
Create a new plan/component subscription or up/downgrade order
Process and finalize an order
[FEATURE] Approve an order
[FEATURE] Decline an order
Retrieve a list of all customers
Create a new customer
Retrieve a single customer
Replaces a customer's data
Updates parts of a customer
Deletes a customer
Retrieves a list of all contracts for the given customer id
Retrieve a list of contracts
Retrieves a single contract by Id
Retrieves a contract's associated usage
Posts new metered usage data
Remove an unbilled metered usage
Retrieves current subscriptions in the selected contract
Create a new component subscription for this contract
Retrieves all currently active subscriptions including plan variant, component subscriptions and discount subscriptions
Retrieve a short-lived selfservice access token
Retrieves a cancellation preview for a contract for a regular cancellation, considering contract and notice periods of the booked PlanVariant.
Set an enddate for this contract
Create a Rated Item for this contract
Retrieves combined customer and contract data
Retrieves a list of all invoices / credit notes
Retrieves an invoice by id
Creates a file download token for the given invoice
Retrieves a list of all invoice drafts
Retrieves a draft by id
Sends the given invoice draft id, thus converting it to an invoice. Returns the newly created invoice
Retrieves a list of plan groups
Retrieves a single Plangroup by ID
Retrieve a list of available plans
Retrieves a single plan by ID
Retrieves a list of available Planvariants
Retrieves a single Planvariant by ID
Lists all webhooks that you currently have registered
Create a new webhook subscription
Deletes the webhook from the system
Create a new plan/component subscription or up/downgrade order
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | * | OrderDTO |
Process and finalize an order
Kind: global function
| Param | Type | Description |
|---|---|---|
| orderId | string | Order ID |
| data | * | OrderCommitDTO |
[FEATURE] Approve an order
Kind: global function
| Param | Type | Description |
|---|---|---|
| orderId | string | Order ID |
[FEATURE] Decline an order
Kind: global function
| Param | Type | Description |
|---|---|---|
| orderId | string | Order ID |
Retrieve a list of all customers
Create a new customer
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | * | CustomerDTO |
Retrieve a single customer
Kind: global function
| Param | Type | Description |
|---|---|---|
| customerId | string | Customer ID |
Replaces a customer's data
Kind: global function
| Param | Type | Description |
|---|---|---|
| customerId | string | Customer ID |
| data | * | CustomerDTO |
Updates parts of a customer
Kind: global function
| Param | Type | Description |
|---|---|---|
| customerId | string | Customer ID |
| data | * | CustomerDTO |
Deletes a customer
Kind: global function
| Param | Type | Description |
|---|---|---|
| customerId | string | Customer ID |
Retrieves a list of all contracts for the given customer id
Kind: global function
| Param | Type | Description |
|---|---|---|
| customerId | string | Customer ID |
Retrieve a list of contracts
Retrieves a single contract by Id
Kind: global function
| Param | Type |
|---|---|
| contractId | string |
Retrieves a contract's associated usage
Kind: global function
| Param | Type |
|---|---|
| contractId | string |
Posts new metered usage data
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
| data | * | MeteredUsageDTO |
Remove an unbilled metered usage
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
| usageId | string | Metered Usage ID |
Retrieves current subscriptions in the selected contract
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
Create a new component subscription for this contract
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
| data | * | ComponentSubscriptionCreateDTO |
component subscriptions and discount subscriptionsding plan variant,
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
Retrieve a short-lived selfservice access token
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
considering contract and notice periods of the booked PlanVariant.ellation,
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
Set an enddate for this contract
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
| data | * | ContractEndDTO |
Create a Rated Item for this contract
Kind: global function
| Param | Type | Description |
|---|---|---|
| contractId | string | Contract ID |
| data | * | RatedItemCreateDTO |
Retrieves combined customer and contract data
Retrieves a list of all invoices / credit notes
Retrieves an invoice by id
Kind: global function
| Param | Type | Description |
|---|---|---|
| invoiceId | string | Invoice ID |
Creates a file download token for the given invoice
Kind: global function
| Param | Type | Description |
|---|---|---|
| invoiceId | string | Invoice ID |
Retrieves a list of all invoice drafts
Retrieves a draft by id
Kind: global function
| Param | Type | Description |
|---|---|---|
| invoiceDraftId | string | Invoice Draft ID |
Returns the newly created invoice thus converting it to an invoice.
Kind: global function
| Param | Type | Description |
|---|---|---|
| invoiceDraftId | string | Invoice Draft ID |
Retrieves a list of plan groups
Retrieves a single Plangroup by ID
Kind: global function
| Param | Type |
|---|---|
| planGroupId | string |
Retrieve a list of available plans
Retrieves a single plan by ID
Kind: global function
| Param | Type | Description |
|---|---|---|
| planId | string | Plan ID |
Retrieves a list of available Planvariants
Retrieves a single Planvariant by ID
Kind: global function
| Param | Type | Description |
|---|---|---|
| planVariantId | string | PlanVariant ID |
Lists all webhooks that you currently have registered
Create a new webhook subscription
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | * | HookDTO |
Deletes the webhook from the system
Kind: global function
| Param | Type | Description |
|---|---|---|
| webhookId | string | Webhook ID |
FAQs
Node wrapper for the billwerk API: https://developer.billwerk.io/Docs/ApiReference
The npm package billwerk receives a total of 57 weekly downloads. As such, billwerk popularity was classified as not popular.
We found that billwerk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
