Billing

A quick introduction to the essential dev tools for building with Airwallex

Developer Essentials

Explore the flexibility and power of Airwallex APIs

Quickly and securely integrate with Airwallex products using Airwallex SDKs

SDKs

Learn how to receive push notifications via webhooks

Webhooks

Use Airwallex's demo environment to simulate transactions before going live

Demo environment

This section describes Billing webhooks, which are only applicable for API version 2025-06-16 and later.


```javascript
{
    "id": "790fb1e1-01e6-41d5-a821-297d51b43599",
    "name": "subscription.created",
    "account_id": "acct__ncI2nypPKSq2VXKxscAcg",
    "created_at": "2022-08-02T03:07:55+0000",
    "data":Object{...}
}
```

__data__ is the response body from [Retrieve a Subscription](https://www.airwallex.com/docs/api#/Billing/Subscriptions/_api_v1_subscriptions__id_/get)
```javascript
{
  "billing_customer_id": "bcus_hkpd7fedfgb004apkvs",
  "cancel_at": "null",
  "cancel_at_period_end": false,
  "cancel_requested_at": "null",
  "collection_method": "AUTO_CHARGE",
  "created_at": "2022-01-01T10:15:30+0000",
  "currency": "USD",
  "current_period_ends_at": "2022-02-05T10:15:30+0000",
  "current_period_starts_at": "2022-01-05T10:15:30+0000",
  "days_until_due": 0,
  "default_invoice_template": {
    "invoice_memo": "Thanks for your purchase."
  },
  "default_tax_percent": 0.7,
  "id": "sub_hkpdkcmxdgazzq53jbk",
  "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl",
  "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ",
  "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg",
  "metadata": {
    "foo": "bar"
  },
  "next_billing_at": "2022-02-05T10:15:30+0000",
  "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s",
  "recurring": {
    "period": 1,
    "period_unit": "MONTH"
  },
  "remaining_billing_cycles": 12,
  "starts_at": "2022-01-01T10:15:30+0000",
  "status": "ACTIVE",
  "total_billing_cycles": 12,
  "trial_ends_at": "2022-01-05T10:15:30+0000",
  "trial_starts_at": "2022-01-01T10:15:30+0000",
  "updated_at": "2022-01-01T10:15:30+0000"
}
```


subscription.*

```javascript
{
    "id":"9c830876-5290-4a46-b3b0-aa3c6d8e8b50",
    "name":"invoice.created",
    "account_id":"acct__ncI2nypPKSq2VXKxscAcg",
    "created_at": "2022-08-02T03:07:55+0000",
    "data":Object{...}
}
```

__data__ is the response body from [Retrieve an Invoice](https://www.airwallex.com/docs/api#/Billing/Invoices/_api_v1_invoices__id_/get)
```javascript
{
  "billing_customer_id": "bcus_hkpd7fedfgb004apkvs",
  "collection_method": "CHARGE_ON_CHECKOUT",
  "created_at": "2022-01-01T10:15:30+0000",
  "currency": "USD",
  "days_until_due": 1,
  "default_tax_percent": 0.05,
  "due_at": "2022-12-05T10:15:30+0000",
  "finalized_at": "2022-12-05T10:15:30+0000",
  "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token",
  "id": "inv_hkpd49cskgblns6iimw",
  "last_payment_attempt_at": "2022-12-05T10:15:30+0000",
  "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ",
  "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg",
  "memo": "Invoice memo.",
  "metadata": {
    "foo": "bar"
  },
  "next_payment_attempt_at": "2022-12-05T10:15:30+0000",
  "number": "INV-YOLI0II9-0685",
  "paid_at": "2022-12-05T10:15:30+0000",
  "paid_out_of_band": false,
  "past_payment_attempt_count": 1,
  "payment_source_id": "psrc_d3Ds20ae5VihKs092",
  "payment_status": "UNPAID",
  "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token",
  "remaining_payment_attempt_count": 1,
  "status": "FINALIZED",
  "subscription_id": "sub_hkpdkcmxdgazzq53jbk",
  "total_amount": 100,
  "total_tax_amount": 0,
  "updated_at": "2022-01-01T10:15:30+0000",
  "voided_at": "2022-12-05T10:15:30+0000"
}
```

invoice.*

```javascript
{
    "id":"9c830876-5290-4a46-b3b0-aa3c6d8e8b50",
    "name":"billing_transaction.created",
    "account_id":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "created_at": "2022-08-02T03:07:55+0000",
    "data":Object{...}
}
```

__data__ is the response body from [Retrieve a Billing Transaction](https://www.airwallex.com/docs/api#/Billing/Billing_Transactions/_api_v1_billing_transactions__id_/get)
```javascript
{
  "amount": 19.99,
  "billing_customer_id": "bcus_hkpd7fedfgb004apkvs",
  "cancelled_at": "2023-06-15T12:30:00+0000",
  "created_at": "2023-06-15T12:30:00+0000",
  "currency": "USD",
  "external_id": "int_e65tkXCSzJrsMpTrzoFrjaau53",
  "id": "btxn_hkst2n8dxh3h6vaiq9i",
  "invoice_id": "inv_hkpd49cskgblns6iimw",
  "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg",
  "metadata": {
    "order_id": "ORD-12345"
  },
  "out_of_band": false,
  "payment_source_id": "psrc_sgstvjkjjh7lzraf39f",
  "status": "SUCCEEDED",
  "succeeded_at": "2023-06-15T12:35:01+0000",
  "updated_at": "2023-06-15T12:30:00+0000"
}
```

billing_transaction.*

This section describes the Billing webhook, which are only applicable for API version 2025-04-25 and before.

```javascript
{
    "id": "790fb1e1-01e6-41d5-a821-297d51b43599",
    "name": "subscription.created",
    "source_id": "sub_hkstzqcl4gc7ma2ykn7",
    "account_id": "78814faa-1b30-4598-a9c8-f0583db8d09d",
    "created_at": "2022-08-02T03:07:55+0000",
    "data":{
        "object": {...}
    }
}
```

__object__ is the response body from [Retrieve a Subscription](https://www.airwallex.com/docs/api#/Billing/Subscriptions/_api_v1_subscriptions__id_/get)
```javascript
{
  "id": "sub_hkstzqcl4gc7ma2ykn7",
  "status": "ACTIVE",
  "customer_id": "cus_hkst2q96fgbzw4gdpyc",
  "payment_consent_id": "cst_hkstp6spzgc7m9xic5y",
  "latest_invoice_id": "inv_hkstc4dn8gc7ma30pq1",
  "trial_start_at": null,
  "trial_end_at": null,
  "current_period_start_at": "2022-08-02T03:07:53+0000",
  "current_period_end_at": "2022-09-02T03:07:53+0000",
  "created_at": "2022-08-02T03:07:55+0000",
  "updated_at": "2022-08-02T03:07:55+0000",
  "cancel_at": "2023-08-02T03:07:53+0000",
  "cancel_at_period_end": false,
  "cancel_requested_at": null,
  "next_billing_at": "2022-09-02T03:07:53+0000",
  "remaining_billing_cycles": 11,
  "total_billing_cycles": 12,
  "recurring": {
    "period": 1,
    "period_unit": "MONTH"
  },
  "metadata": {}
}
```

```javascript
{
    "id":"9c830876-5290-4a46-b3b0-aa3c6d8e8b50",
    "name":"invoice.sent",
    "source_id": "inv_hkstc4dn8gc7ma30pq1",
    "account_id":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "created_at": "2022-08-02T03:07:55+0000",
    "data":{
        "object": {...}
    }
}
```

__object__ is the response body from [Retrieve an Invoice](https://www.airwallex.com/docs/api#/Billing/Invoices/_api_v1_invoices__id_/get)
```javascript
{
  "id": "inv_hkstc4dn8gc7ma30pq1",
  "customer_id": "cus_hkst2q96fgbzw4gdpyc",
  "status": "SENT",
  "currency": "USD",
  "total_amount": 5,
  "subscription_id": "sub_hkstzqcl4gc7ma2ykn7",
  "payment_intent_id": "int_hkstp6spzgc7ma34l23",
  "period_start_at": "2022-08-02T03:07:53+0000",
  "period_end_at": "2022-09-02T03:07:53+0000",
  "past_payment_attempt_count": 0,
  "created_at": "2022-08-02T03:07:53+0000",
  "updated_at": "2022-08-02T03:07:55+0000"
}
```

docsLogo

Guest user checkout

Registered user checkout

Place a hold on a payment method

3D Secure authentication

Enhance fraud protection with comprehensive payment data

Device fingerprinting

Cancellations

Refunds

Network Tokenization

Card Account Updater

Multi-currency pricing

Error response codes

Native API

Simulate RFI sessions

Risk

Simulate cardholder status transition

Simulate transactions on issued cards

Issuing

Simulate transfer status transition

Payouts

Simulate payment disputes

Simulate shopper action

Payments

Simulate Linked Account and DD mandate status transition

Linked Accounts

Simulate deposits to your Global Account

Deposits

Simulate connected account status transition

Simulate account amendment status transition

Connected accounts

Demo environment overview

Install Airwallex Sales Order App

View transactions

Australia (AU_BECS_DEBIT)

Australia (AU_PAYTO_DEBIT)

United States (US_ACH_DEBIT)

United States (US_FEDWIRE_DEBIT)

United Kingdom (GB_BACS_DEBIT)

Europe SEPA (EU_SEPA_DEBIT)

Canada (CA_EFT_DEBIT)

Hong Kong (HK_FPS_DEBIT)

Singapore (SG_EGIRO_DEBIT)

New Zealand (NZ_BECS_DEBIT)

Review direct debit mandate requirements

Accept PayTo payments

PayTo - BETA

Onboard multiple connected accounts

Onboard multiple connected accounts for the same legal entity

7-Eleven

Alipay CN

Alipay HK

Atome

Boost

DANA

DOKU Wallet

Dragonpay

DuitNow

E.SUN (Taiwan ATM & Internet banking)

GCash

GoPay

GrabPay - Malaysia

GrabPay - Singapore

Indonesian Bank Transfer

Indonesian Convenience Stores - BETA

Jenius Pay

Kakao Pay

Kiosk Payments

Konbini

Korean Local Cards - BETA

Laybuy by Klarna

LinkAja

Naver Pay - BETA

Pay-easy

Payco - BETA

PayNow

Philippines Online Banking

PromptPay

Rabbit LINE Pay

Samsung Pay - BETA

ShopeePay

Taiwan Convenience Stores

Tesco Lotus

Thailand Online Banking

Toss Pay - BETA

Touch 'n Go

TrueMoney

WeChat Pay

Zip - BETA

APAC

Payment Links via API

Payment Links via web app

Payment Links overview

Test your custom domain

Remove your custom domain

Set up your custom domain 

Custom domains (Beta)

Manage approvals for batch transfers

Manage batch transfers

Install Airwallex Online Payments app

SDK examples

Low-level API integration

Redirect

Card

Apple Pay

Native UI integration

Before you start

Overview

iOS Airwallex SDK

Airwallex iOS SDK Privacy Details

Mobile SDK

Embedded KYC RFI component

Hosted KYC RFI flow

Native KYC RFI API

Handle KYC RFI

Payments & fee rounding

Cameroon

Central African Republic

Chad

Eswatini

Madagascar

Djibouti

Republic of the Congo

Togo

Zimbabwe

Tuvalu

Turks and Caicos Islands

Trinidad and Tobago

Tonga

Suriname

Solomon Islands

Sierra Leone

Sao Tome and Principe

Samoa

Saint Vincent and the Grenadines

Saint Kitts and Nevis

Saint Helena, Ascension and Tristan da Cunha

Rwanda

Papua New Guinea

Palau

Northern Mariana Islands

Niger

Nicaragua

Montserrat

Mongolia

Micronesia

Marshall Islands

Malawi

Liberia

Lesotho

Lebanon

Lao People's Democratic Republic

Kiribati

Holy See (Vatican City)

Guinea-Bissau

Guinea

Ghana

Gambia

Powerful and flexible APIs to programmatically manage your money

Platform APIs

APIs and components to build your own global financial products.

Embedded Finance Use Cases

Programmatically create accounts and onboard customers

Connected Accounts icon

Programmatically create connected accounts for businesses and individuals, and enable them with rich financial capabilities.

Connected Accounts

How connected accounts work

Supported regions

Get started

Manage accounts

Move funds

Accounts icon

Open and manage global accounts at scale in 20+ currencies.

Accounts

Supported regions and currencies

Receive funds

Process payouts

Test and go live

Accept one-time and recurring payments, with like-for-like settlement for multiple currencies

PaymentsActive

PaymentsNormal

Billing

.css-1xcsryl>.e1x8zjqq1{opacity:0;-webkit-transition:opacity 250ms ease-in-out;transition:opacity 250ms ease-in-out;}.css-1xcsryl:hover>.e1x8zjqq1{opacity:1;}subscription.*.css-158icaa{margin-left:4px;}

invoice.*

billing_transaction.*

subscription.*

invoice.*

subscription.*