Connectivity Lifecycle

Top-up order

Top up an existing subscription by creating a top-up order.

This flow is used to add an additional product, such as allowance or an additional number, or extend the capabilities of an existing subscription.

Best for: Use this flow when you want to add allowance or activate additional capacity without changing the core subscription lifecycle.


What you will do

Top-up order, step by step

Follow the exact partner journey used to create a top-up order and track the resulting lifecycle events.

Allowance lifecycle

Top-up order, step by step

Follow the lifecycle used to top up an existing subscription or add capacity through a single order flow.

01
Identify subscription or product to top up
Subscription / product lookup
Result
Target product identified

Identify the subscription or product that will receive the top-up before creating the order.

↓
02
Create top-up order
POST /orders
Result
201 Order Created

Create a topup_subscription order type so Connect can add the requested allowance or product capacity.

↓
03
Top-up applied
Webhook delivery / product state
Result
Updated product state visible

Once processed, the top-up is reflected in the product lifecycle and your systems should show the updated state or newly activated add-on.

Events
product.activeorder.completedinvoice.paid (prepaid only)phone_number.active (additional phone number only)