Charge a subscription invoice

POST

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

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

🟢200OK

application/json

Charge initiated successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠409409

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/subscriptions/subscription-invoices//charge' \
--header 'x-business-id;' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "force_retry": false,
    "metadata": {
        "reason": "manual_charge"
    }
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "invoice": {
            "uid": "string",
            "status": "string",
            "attempt_count": 0,
            "next_payment_attempt": "string",
            "processing": true
        },
        "charge_attempt": {
            "uid": "string",
            "invoice_id": "string",
            "invoice_id_hash": "string",
            "amount": "string",
            "status": "PENDING",
            "transaction_hash": "string",
            "block_number": 0,
            "gas_used": "string",
            "gas_price": "string",
            "error_message": "string",
            "retry_count": 0,
            "metadata": {},
            "created_at": "string",
            "updated_at": "string"
        }
    }
}

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

Get a subscription invoice by UID

Get charge attempts for an invoice