Create a subscription invoice

POST

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

Subscriptions

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

Invoice created successfully

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/subscriptions//subscription-invoices' \
--header 'x-business-id;' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "100.00",
    "description": "Monthly subscription fee",
    "due_date": "2024-02-01T00:00:00Z",
    "metadata": {
        "period": "2024-01"
    }
}'

Response Example

201 - Example 1

{
    "success": true,
    "data": {
        "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"
        ]
    }
}

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

Update a subscription price

List subscription invoices