univoozAPI

Plans and payment

What your plan includes, and what stops when an invoice is not paid.

Two separate questions control each request: what your plan includes, and is it paid.

Advanced plan functions

These need features_advancedApi:

FunctionOn Standard
POST /v1/orders/quote403 feature_not_available
WebhooksUnivooz sends nothing. You cannot add an endpoint.

Standard includes everything else: create, read, list, change and cancel orders, address checks, branches and test mode. Standard is a complete integration.

Univooz reads the plan for each webhook event. So a change from Advanced to Standard stops the events immediately.

When payment stops

SubscriptionResult
activeEverything works.
past_dueEverything still works. Stripe is retrying the payment.
unpaid or canceledPOST /v1/orders gives 402 subscription_inactive.

Only new orders stop. You can still read, list, change, cancel and advance your orders, and their webhooks continue.

Why. Parcels that a courier already has must still arrive, and you must still see them. A payment problem must not stop a delivery in progress.

An Advanced endpoint on an unpaid subscription gives 402, not 403. Your plan includes it, so pay the invoice — do not upgrade.

The warning header

While the subscription is past_due, POST /v1/orders and POST /v1/orders/quote return:

Univooz-Subscription-State: past_due

The header is absent in all other states.

Look for it in your logs. You then learn about a failed card before an order stops. This is the cheapest monitoring on the API.

Charges for orders

Univooz records a charge when you create an order. Orders inside your plan cost nothing more. Univooz invoices extra orders at the end of the period.

  • Test orders have no charge.
  • Cancellation does not remove the charge. Univooz records it at creation.

On this page