Wingback

User Guides

User Manuals

SGI Fundamentals

Developer Documentation

Go to Dashboard

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

List Invoices

A supported currency

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

Detailed Status of an invoice, taking into account the
status of the eventual payment:

* pending_validation: in wait for a validation of the invoice
* paid: invoice is paid
* not_yet_due: the invoice due date hasn't been reached
* customer_not_active: customer not being active, we don't process their invoices
* canceled_unpaid_transaction: a previously created but unrealized deposit transaction has been canceled - the status will change next time the billing engine runs
* canceled_self_handled_payment: a previously created manual payment has been canceled, a new one is necessary
* pending_payment_processing: not yet processed - transitory state
* no_valid_payment_method: invoice is configured for automatic payment but there's no valid automatic payment method
* sum_smaller_than_payment_threshold: the total amounts of all invoices which can be gathered in a payment (same customer and currency) is smaller than the minimal amount of a transaction
* automatic_payment_in_progress: a non-instant payment (e.g. SEPA) is being processed
* awaiting_self_handled_payment: the invoice isn't set for automatic payment and no manual payment was registered
* self_handled_payment_in_progress: a self-handled payment has been registered by the wb_customer but hasn't been validated yet
* self_handled_payment_failed: a self-handled payment has been registered by the wb_customer but has been flagged as failed
* automatic_payment_canceled: an automatic payment has been canceled by the payment processor
* payment_error_retry: there was an error, the billing engine will retry later
* payment_error_no_retry: there was an error, the billing engine won't retry unless it's requested to do it

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

Overall information about the issued 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)

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

An invoice with a detailed status and some plan information
for lists

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

The payment providers known by the backend.

Those variants MUST be kept identical to the variants of
the payment_provider enum of the postgres database

api key

wb user cookie

A paginated result of the requested resource
This is based on Keyset Pagination
https://vladmihalcea.com/sql-seek-keyset-pagination/

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

Get Invoice

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

List Invoices

Authorizations

Query Parameters

Response