Charge Subscription Invoice

POST

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

Subscriptions

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

API Key

Add parameter in header

X-Business-ID

Example:

X-Business-ID: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Default Response

Body

🟠400

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/subscriptions/subscription-invoices//charge' \
--header 'X-API-Key: <api-key>' \
--header 'X-Business-ID: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "force_retry": false,
    "metadata": {}
}'

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",
            "status": "string",
            "transaction_hash": "string",
            "block_number": 0,
            "gas_used": "string",
            "error_message": "string",
            "created_at": "string"
        }
    }
}

Modified at 2026-04-14 01:46:40

Get Subscription Invoices Details

Get Charge Attempts