Create a metered subscription invoice

POST

/api/v1/subscriptions/{uid}/metered-invoices

Subscriptions

Create an invoice for usage-based (METERED) billing with EIP-712 authorization.
This endpoint is specifically for metered subscriptions where billing is based on actual usage.

📖 For detailed implementation guide, see: Subscriptions Documentation

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Metered invoice created successfully with EIP-712 authorization

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

cURL

api_usageimmediate_chargescheduled_charge

curl --location --request POST '/api/v1/subscriptions//metered-invoices' \
--header 'x-business-id;' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "1500.00",
    "currency": "NGN",
    "usage_description": "API calls for January 2024",
    "metadata": {
        "period": "2024-01",
        "service": "api"
    }
}'

Response Example

201 - Example 1

{
    "success": true,
    "invoice": {
        "uid": "string",
        "subscription_id": "string",
        "invoice_id": "string",
        "amount": "string",
        "currency": "string",
        "token_address": "string",
        "billing_mode": "FIXED",
        "usage_quantity": 0,
        "usage_description": "string",
        "status": "DRAFT",
        "description": "string",
        "due_date": "string",
        "paid_at": "string",
        "voided_at": "string",
        "attempt_count": 0,
        "next_payment_attempt": "string",
        "processing": true,
        "metadata": {},
        "created_at": "string",
        "updated_at": "string",
        "subscription": {},
        "charge_attempts": [
            "string"
        ]
    },
    "eip712": {
        "domain": {},
        "types": {},
        "message": {}
    }
}

Modified at 2025-09-15 21:23:04

List subscription invoices

Get a subscription invoice by UID