Wingback

User Guides

User Manuals

SGI Fundamentals

Developer Documentation

Go to Dashboard

Get Invoice

A supported currency

The format for parsing and reading is the lowercased
ISO 4217 currency code (e.g. "usd")

Describes the status of the customer for Entitlement response

Status of the Customer
* Active - customer is active
* Inactive - Customer account was deactivated
* Temporary - Customer was created, but registration process was not completed

A transaction with some data fetched from the
claim, the ledger_transaction, the contract/plan,
and the payment execution.

It's a consolidation for user interfaces.

IDs of the Invoices this transaction covers

Unique identifier of an object. Consists of object class prefix and a UUID

Overall information about the issued invoice

Total amount that was applied from the Customer's virtual wallet

Descriptions of all discounts applied to this invoice

Total amount that was discounted on this invoice

Indicates if EU TAX Reverse Charge applied

Total amount on the invoice prior to applying discounts and taxes

Total amount of tax charged on the invoice

Status of the deposit transaction creation, which
explains, whent the deposit transaction wasn't
created, why it's the case.

This status isn't meant for (wb_)customer display
as it's quite technical. For this purpose,
see DetailedInvoiceStatus.

When the invoice holds a deposit transaction id,
then this status is *always* Created (enforced by
DB constraint)

Invoice Item, or in other words Invoice Line.
An invoice always consists of one or more Invoice Item, which is a concrete
charge for a concrete feature. The invoice item contains full information about:
* the feature that is being billed for
* the amount of units of the feature that is being charged for
* discounts and taxes applied

Description of the discount used for this invoice item

Name of the feature this InvoiceItem is for

Number of units. For flat price features this will be 1

Status of the invoice item:
* PendingValidation - invoice item awaits manual review
* Validated - invoice item is ready to be attached to an invoice

Helper type providing additional information on the invoice item

The sequence of charge ids leading to this
charge, from parent to child.

For example  [GrandParentChargeId, ParentChargeId, ThisChargeId]
Never empty, the rightest element being the id of the charge of
this invoice_item_detail.
This charge_path is the natural key for ordering invoice items
in an invoice.

Scheduling policy for invoice items:
* Immediate - Invoicing (and payments if automated) must be immediate
* Periodic - Scheduling is normal for the contract, allowing batches

Status of the invoice:
* PendingValidation - Invoice awaits manual review
* ReadyForPayment - invoice can be paid
* Paid - invoice was paid

Status of the LedgerTransaction:
* Pending - the Transaction is being executed
* Completed - the Transaction has completed
* Canceled - the Transaction was canceled

Details about the payment method
* SelfServe - paid manually
* Card - credit card
* SepaDebit - SEPA bank payments

Payment execution status:
* Pending - pending processing
* ErrorRetry - error, will be retried
* ErrorNoRetry - error, retrying impossible
* InProgress - in progress
* Done - completed
* Canceled - canceled

Details of the attached credit card, configured as a payment method

Credit card brand - Visa, MasterCard, American Express etc

Credit card expiration date. Follows MM/YY format

Details of the configured payment method for SEPA payments

Two options for handling taxes:
- TaxIncluded means that unit_price already includes tax, and so true unit_price
equals to: unit_price = true unit_price + tax. True unit_price will be adjusted
on the invoice so that the final price matches desired price in the unit_price
field
- TaxOnTop means that unit_price is true unit_price, tax will be added on top, and
unit_price will not be changed as a result of the tax calculation

The status of a transaction in the billing model

Bank details that the Customer can use to settle invoices

api key

wb user cookie

Find the information you need to get started with Wingback

Introduction

How different teams can use Wingback for success.

Wingback for Sales

Wingback Growth

Wingback for Product

Use Wingback to reduce inbounds and improve CX and satisfaction.

Wingback for Customer Success

Wingback for Finance

An overview of the most important features of Wingback.

Your central hub for creating and editing plans.

Plan Editor

Boost product-led growth without creating engineering work

Pricing Pages

Streamline your customer management workload while gaining valuable insights.

Customer Management Portal

Give your customers greater visibility and control to reduce CS & Sales time.

Self-serve Billing Portal

Overview of payment gateways and methods in Wingback

Supported Payment Methods

Wingback has multiple components that support the growth of your SaaS business. We allow you to deploy pricing plans as quickly as possible and implement any pricing plan changes with minimal effort and engineering involvement.

Manage customer access to your product's functionality with by mapping into Wingbacks Features and Entitlements

Working with Features and Entitlements

Integrating Wingback into your Signup Flow

Billing Portal Integration

Adding a Dynamic Pricing Page to Your Website

Introduction to Usage-based Pricing and Billing

Metering Usage

Webhooks

Variable Invoicing Schedules

The API creates a new customer within Wingback or updates an existing one.

Create New Customer

Retrieve customer by id. The API returns customer and the contract that the customer is currently on

Get Customer

Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned

Search for Customers

The API unpauses the customer. A paused customer will not be charged for his subscriptions and Entitlement API will show that the customer is not active and can't use the assigned features.

Activate Customer

The API freezes the customer, putting their subscription on pause and all the customer data into read-only mode. The customer will not be charged for any subscriptions as they are not considered active.

Freeze/Inactivate Customer

Add Address

The API returns an address belonging to the customer

Get Address

Delete Address

Subscribe Customer to a Plan

Retrieve Contract Details

Upgrade/Change Plan

Estimate Upgrade Costss

Create an authentication token for a customer and return a URL for accessing their self-serve billing portal.

Login a Customer to the Self-Serve Portal

Retrieve a list of all features a customer currently has access to.

Get Access Entitlements

Retrieve current plan, payment cycle, payment status and account status for a customer

Get Billing Entitlements

Increment the usage counters for a specific feature and customer within the current billing period.

Report Single Event

Bulk Usage Upload

Create a Payment Session to collect credit card/direct debit information from the customer using [Wingback.js.](/dev/guides/integrate-wingback-signup-flow#create-a-payment-method-session-in-wingback-backend)

Create Payment Session

Create a new payment method and select it. Currently, only Stripe VBAN transfer is supported. To add credit cards or direct debit, create a [Payment Session](dev/api-reference/payment/post_c_customer_customerid_payment_session) and collect the data using [Wingback.js.](/dev/guides/integrate-wingback-signup-flow#create-a-payment-method-session-in-wingback-backend)

Add Payment Method

Return all payment methods of a customer, including
the inactive ones but not the detached ones

List saved Payment Methods

Return a specific payment method found by its id, checking
it belongs to that wb_customer and customer

Get Saved Payment Method

Set the payment method selection of the customer

Set Default Payment Method

Return all balances of a customer (one balance per currency).

Get Current Customer Balance

Retrieve virtual balances (one balance per currency).

Get Virtual Balances

Add virtual credits to the virtual balance in a specific virtual currency.

Add Virtual Credits

Retrieve a list of all your invoices filtered by various parameters and their payment status.

List Invoices

Configure Global Invoicing Preferences

Manually Trigger Invoice Generation

An in-depth walkthrough of the Billing Portal for your customers to upgrade their plan, manage their account data, and view their invoices.

An in-depth walkthrough of the Customer Management Portal of our product.

Your central hub for creating & modifying plans

An in-depth walkthrough of the Pricing Pages section of our product.

Defining industry-specific and Wingback-specific terms.

Industry-specific terms that will help you understand what we are talking about.

Industry Glossary

Some terms that we use and our definition of them.

Terms We Use Inside Our Product

A single price that remains the same for every customer for your whole plan.

Simple Flat Fee Pricing

A single price that remains the same for every customer plus a unit-based price that increases when more units are purchased.

Flat Fee + Per-Unit (Per Seat) Pricing

A single price that remains the same for every customer plus a usage-based price that increases when more usage occurs.

Flat Fee + Usage-Based Pricing

A single price that remains the same for every customer plus a transaction-based component that increases with the volume of transactions being processed.

Flat Fee + Transaction-Based Pricing

Simple Unit-Based (Per-Seat) Pricing

A usage-based price that increases with more usage.

Simple Usage-Based Pricing

A price that increases with the volume of transactions processed.

Simple Transaction-Based Pricing

Tiers + Flat-Fee Pricing

Different fixed price levels plus a unit-based price that increases when more units are purchased.

Tiers + Unit-Based (Per Seat or Other Unit) Pricing

Different fixed price levels plus a usage-based price that increases with usage.

Tiers + Usage-Based Pricing

Different fixed price levels plus a transaction-based component that increases with the volume of transactions.

Tiers + Transaction-Based Pricing

Different fixed price levels plus a unit-based price that increases when more units are purchased, plus a usage-based price that increases with usage.

Tiers + Per-Unit (Per Seat or Other Unit) + Usage-Based Pricing

Different fixed price levels plus a unit-based price that increases when more units are purchased, plus a transaction-based price that increases with the transaction volume being processed.

Tiers + Per-Unit (Per Seat or Other Unit) + Transaction-Based Pricing

A unit-based price that increases when more units are purchased, plus a usage-based price that increases with usage.

Per-Unit (Per Seat or Other Unit) + Usage-Based Pricing

Features that you price that can be added to your plans by your customers.

Add-Ons

Plans can come with a free trial period or with a tier that can be used for free.

Welcome

Guides

Wingback.js

Advanced

API Reference

Get Invoice

Authorizations

Path Parameters

Response