Wingback

User Guides

User Manuals

SGI Fundamentals

Developer Documentation

Go to Dashboard

Retrieve Contract Details

Detailed information about the current billing period

Current billing period index (starting from 1, ascending)

Status of the contract:
* Active - Contract is active
* Pending - Contract is not active
* Scheduled - Contract is scheduled to activate in the future
* Canceled - Contract has been canceled
* Moved - User upgraded from this contract to a different one
* NotReady - Contract was created, but billing engine has not completed contract setup

A supported currency

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

Enum that lists supported payment cycles for contracts:
* Once - one-time payment
* Constant - one-time payment for the duration of the contract
* Week - contract is paid weekly
* Month - contract is paid monthly
* Quarter - contract is paid every quarter
* Year - contract is paid yearly

Type of the discount:
* Percentage - a percent of the amount, for example 10%
* Flat - flat amount, for example $10

Determines when the due_date of the invoices should be set when created:
* StartOfPeriod - invoices are due at the beginning of the billing period
* EndOfPeriod - invoices are due at the end of the billing period

Detailed breakdown of the estimated charges

Amount to be charged at the start of the given cycle

Amount to be charged at the end of the cycle (except usage)

Minimum amount of usage that will be charged

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

When the invoices should be created

Note: EveryCycle and Periodic aren't yet supported,
they will behave as Manual

invoices are created as soon as invoice items are validated

invoices are created on wb_customer action

Determines how overusage should be charged:
* AllUsageOvercharge - when using over maximum amount, all usage is charged at overusage price
* ExtraUsageOvercharge - when using over maximum amount, only the amount over maximum
is charged at overusage price

Billing period of the contract. For example, for contracts that are paid monthly,
a new billing period would be created each month. For Constant or Once contracts, a single
period would be created with empty "end" value

Pricing strategy of the Plan:
* Plan - Plan itself contains a price, and it will be used.
* Feature - Each feature in the plan is configured with a price, and final price of the plan
is the combination of prices of all its features

Number of units where this tier starts applying.

Either a number of `infinity`. Must be a string

Enum that lists supported trigger cycles for periodic triggers:
* Month - every month
* Quarter - every quarter
* Year - every year

How period are generated, independently from a start
or end

the number of days/week/month etc. in a period

Number of full days between the cycle's natural start and
the claims starts. For example if claims are to start on
the morning of the 14 each month, the offset will be 13.
This value can be null, meaning either that it's not
specified at this level (eg in preferences) or that it's
0 (ie a natural cycle)

Determines how usage period should be closed:
* Automatic - usage period will be closed as soon as claim period ends
* Manual -  usage period will be open until closed manually
* Delayed - automatic with delay after the claim period ends. Valid delays are 15 minutes, 1 hour, 1 day

Additional Contract-level billing configuration

Should invoice amount be charged automatically or not

Discount Duration. This determines how many billing cycles will Discount be applied
For example, for Monthly cycles, setting this value to 3 will mean that
first 3 month of use will be discounted

Same as Plan Feature, but recorded in the Contract

Number of days the plan will be free. The contract's
cycles will be aligned with the end of the free trial

Name of the Plan. Uses `external_name` if available, otherwise `internal_name`

Information about the price of the feature in the given contract

Additional details about the price that depend on the type of the price

Feature is priced per unit - it's possible to purchase a fixed amount of units

If units can be only purchased in batches, this property specifies in what increments
it would be possible to purchase the feature

Additional flat fee added on top of the purchased units

Maximum number of units that is possible to purchase

Minimum number of units that is possible to purchase

Name of the unit - seats, computers, slots, etc

The final price will depend on the actual usage

If usage is in increments - this number will specify the increments step
For example, if `batch_size` is 5, and actual usage is 8, usage will be rounded up to 10

Additional flat fee added on top of the used units

Minimum number of units that will be charged

Price when using over maximum amount. Defaults to main price if not configured

The number of days from the cycle's natural start (i.e. the
first day of the week/month/quarter/year) to the start of the
cycles

Date of the end of the free trial, if any

End date of the current cycle
(if the contract is active)

api key

wb user cookie

Retrieve Contract by contract_id

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

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

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

Retrieve Contract Details

Authorizations

Path Parameters

Response