Noticeably Playful Monkeys

    billwerk

    2.1.2 • Public • Published

    Functions

    createOrder(data)

    Create a new plan/component subscription or up/downgrade order

    commitOrder(orderId, data)

    Process and finalize an order

    approveOrder(orderId)

    [FEATURE] Approve an order

    declineOrder(orderId)

    [FEATURE] Decline an order

    getCustomers()

    Retrieve a list of all customers

    createCustomer(data)

    Create a new customer

    getCustomer(customerId)

    Retrieve a single customer

    putCustomer(customerId, data)

    Replaces a customer's data

    patchCustomer(customerId, data)

    Updates parts of a customer

    deleteCustomer(customerId)

    Deletes a customer

    getCustomerContracts(customerId)

    Retrieves a list of all contracts for the given customer id

    getContracts()

    Retrieve a list of contracts

    getContract(contractId)

    Retrieves a single contract by Id

    getContractUsage(contractId)

    Retrieves a contract's associated usage

    postContractUsage(contractId, data)

    Posts new metered usage data

    deleteContractUsage(contractId, usageId)

    Remove an unbilled metered usage

    getContractComponentSubscriptions(contractId)

    Retrieves current subscriptions in the selected contract

    createContractComponentSubscription(contractId, data)

    Create a new component subscription for this contract

    getContractSubscriptions(contractId)

    Retrieves all currently active subscriptions including plan variant, component subscriptions and discount subscriptions

    getContractSelfServiceToken(contractId)

    Retrieve a short-lived selfservice access token

    getContractCancellationPreview(contractId)

    Retrieves a cancellation preview for a contract for a regular cancellation, considering contract and notice periods of the booked PlanVariant.

    endContract(contractId, data)

    Set an enddate for this contract

    createContractRatedItem(contractId, data)

    Create a Rated Item for this contract

    getSubscriptions()

    Retrieves combined customer and contract data

    getInvoices()

    Retrieves a list of all invoices / credit notes

    getInvoiceById(invoiceId)

    Retrieves an invoice by id

    getInvoiceDownloadLink(invoiceId)

    Creates a file download token for the given invoice

    getInvoiceDrafts()

    Retrieves a list of all invoice drafts

    getInvoiceDraft(invoiceDraftId)

    Retrieves a draft by id

    sendInvoiceDraft(invoiceDraftId)

    Sends the given invoice draft id, thus converting it to an invoice. Returns the newly created invoice

    getPlanGroups()

    Retrieves a list of plan groups

    getPlanGroup(planGroupId)

    Retrieves a single Plangroup by ID

    getPlans()

    Retrieve a list of available plans

    getPlan(planId)

    Retrieves a single plan by ID

    getPlanVariants()

    Retrieves a list of available Planvariants

    getPlanVariant(planVariantId)

    Retrieves a single Planvariant by ID

    getWebhooks()

    Lists all webhooks that you currently have registered

    createWebhook(data)

    Create a new webhook subscription

    deleteWebhook(webhookId)

    Deletes the webhook from the system

    createOrder(data)

    Create a new plan/component subscription or up/downgrade order

    Kind: global function

    Param Type Description
    data * OrderDTO

    commitOrder(orderId, data)

    Process and finalize an order

    Kind: global function

    Param Type Description
    orderId string Order ID
    data * OrderCommitDTO

    approveOrder(orderId)

    [FEATURE] Approve an order

    Kind: global function

    Param Type Description
    orderId string Order ID

    declineOrder(orderId)

    [FEATURE] Decline an order

    Kind: global function

    Param Type Description
    orderId string Order ID

    getCustomers()

    Retrieve a list of all customers

    Kind: global function

    createCustomer(data)

    Create a new customer

    Kind: global function

    Param Type Description
    data * CustomerDTO

    getCustomer(customerId)

    Retrieve a single customer

    Kind: global function

    Param Type Description
    customerId string Customer ID

    putCustomer(customerId, data)

    Replaces a customer's data

    Kind: global function

    Param Type Description
    customerId string Customer ID
    data * CustomerDTO

    patchCustomer(customerId, data)

    Updates parts of a customer

    Kind: global function

    Param Type Description
    customerId string Customer ID
    data * CustomerDTO

    deleteCustomer(customerId)

    Deletes a customer

    Kind: global function

    Param Type Description
    customerId string Customer ID

    getCustomerContracts(customerId)

    Retrieves a list of all contracts for the given customer id

    Kind: global function

    Param Type Description
    customerId string Customer ID

    getContracts()

    Retrieve a list of contracts

    Kind: global function

    getContract(contractId)

    Retrieves a single contract by Id

    Kind: global function

    Param Type
    contractId string

    getContractUsage(contractId)

    Retrieves a contract's associated usage

    Kind: global function

    Param Type
    contractId string

    postContractUsage(contractId, data)

    Posts new metered usage data

    Kind: global function

    Param Type Description
    contractId string Contract ID
    data * MeteredUsageDTO

    deleteContractUsage(contractId, usageId)

    Remove an unbilled metered usage

    Kind: global function

    Param Type Description
    contractId string Contract ID
    usageId string Metered Usage ID

    getContractComponentSubscriptions(contractId)

    Retrieves current subscriptions in the selected contract

    Kind: global function

    Param Type Description
    contractId string Contract ID

    createContractComponentSubscription(contractId, data)

    Create a new component subscription for this contract

    Kind: global function

    Param Type Description
    contractId string Contract ID
    data * ComponentSubscriptionCreateDTO

    getContractSubscriptions(contractId)

    component subscriptions and discount subscriptionsding plan variant,

    Kind: global function

    Param Type Description
    contractId string Contract ID

    getContractSelfServiceToken(contractId)

    Retrieve a short-lived selfservice access token

    Kind: global function

    Param Type Description
    contractId string Contract ID

    getContractCancellationPreview(contractId)

    considering contract and notice periods of the booked PlanVariant.ellation,

    Kind: global function

    Param Type Description
    contractId string Contract ID

    endContract(contractId, data)

    Set an enddate for this contract

    Kind: global function

    Param Type Description
    contractId string Contract ID
    data * ContractEndDTO

    createContractRatedItem(contractId, data)

    Create a Rated Item for this contract

    Kind: global function

    Param Type Description
    contractId string Contract ID
    data * RatedItemCreateDTO

    getSubscriptions()

    Retrieves combined customer and contract data

    Kind: global function

    getInvoices()

    Retrieves a list of all invoices / credit notes

    Kind: global function

    getInvoiceById(invoiceId)

    Retrieves an invoice by id

    Kind: global function

    Param Type Description
    invoiceId string Invoice ID

    getInvoiceDownloadLink(invoiceId)

    Creates a file download token for the given invoice

    Kind: global function

    Param Type Description
    invoiceId string Invoice ID

    getInvoiceDrafts()

    Retrieves a list of all invoice drafts

    Kind: global function

    getInvoiceDraft(invoiceDraftId)

    Retrieves a draft by id

    Kind: global function

    Param Type Description
    invoiceDraftId string Invoice Draft ID

    sendInvoiceDraft(invoiceDraftId)

    Returns the newly created invoice thus converting it to an invoice.

    Kind: global function

    Param Type Description
    invoiceDraftId string Invoice Draft ID

    getPlanGroups()

    Retrieves a list of plan groups

    Kind: global function

    getPlanGroup(planGroupId)

    Retrieves a single Plangroup by ID

    Kind: global function

    Param Type
    planGroupId string

    getPlans()

    Retrieve a list of available plans

    Kind: global function

    getPlan(planId)

    Retrieves a single plan by ID

    Kind: global function

    Param Type Description
    planId string Plan ID

    getPlanVariants()

    Retrieves a list of available Planvariants

    Kind: global function

    getPlanVariant(planVariantId)

    Retrieves a single Planvariant by ID

    Kind: global function

    Param Type Description
    planVariantId string PlanVariant ID

    getWebhooks()

    Lists all webhooks that you currently have registered

    Kind: global function

    createWebhook(data)

    Create a new webhook subscription

    Kind: global function

    Param Type Description
    data * HookDTO

    deleteWebhook(webhookId)

    Deletes the webhook from the system

    Kind: global function

    Param Type Description
    webhookId string Webhook ID

    Keywords

    none

    Install

    npm i billwerk

    DownloadsWeekly Downloads

    109

    Version

    2.1.2

    License

    MIT

    Unpacked Size

    29.1 kB

    Total Files

    5

    Last publish

    Collaborators

    • maxnowack