Simulate an invoice payment

curl -X POST https://api.runledger.co/v1/test_helpers/invoices/invoice_id/simulate_payment \
     -H "Authorization: Bearer <api_key>" \
     -H "Content-Type: application/json" \
     -d '{
  "result": "succeeded"
}'

{
  "id": "inv_1zX4cV7bNm",
  "object": "string",
  "customer": "string",
  "subscription": "string",
  "status": "draft",
  "currency": "usd",
  "period_start": "2024-01-15T09:30:00Z",
  "period_end": "2024-01-15T09:30:00Z",
  "lines": [
    {
      "id": "il_6yU3iO8pAs",
      "type": "recurring_fee",
      "description": "Chat resolutions",
      "quantity": "3980",
      "amount": 378100,
      "unit_amount_decimal": "95",
      "event_name": "string",
      "outcome_definition": "string",
      "reversals": [
        "string"
      ]
    }
  ],
  "total": 378100,
  "amount_due": 378100,
  "amount_paid": 0,
  "finalizes_at": "2024-01-15T09:30:00Z",
  "collection_method": "charge_automatically",
  "payment_status": "not_attempted",
  "livemode": true,
  "created_at": "2024-01-15T09:30:00Z",
  "number": "RL-000127",
  "finalized_at": "2024-01-15T09:30:00Z",
  "due_at": "2024-01-15T09:30:00Z",
  "paid_at": "2024-01-15T09:30:00Z",
  "hosted_payment_url": "string"
}

Simulates the payment provider collecting, or failing to collect, an open invoice.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

invoice_idstringRequired

The invoice ID (inv_...).

Request

This endpoint expects an object.

resultenumRequired

Allowed values:

Response

The invoice after the simulated payment.

idstring

object"invoice"

customerstring

subscriptionstring

statusenum

draft fills during the period. open is finalized and awaiting payment. paid is settled at the provider.

Allowed values:

currencystring

period_startdatetime

period_enddatetime

lineslist of objects

totalinteger

Sum of the lines, in minor units, never below zero. If credits exceed charges, the rest carries to the next invoice.

amount_dueinteger

amount_paidinteger

finalizes_atdatetime

collection_methodenum

charge_automatically charges the saved payment method. send_invoice emails a payment link from the provider.

Allowed values:

payment_statusenum

Allowed values:

livemodeboolean

created_atdatetime

numberstringOptional

Assigned at finalization.

finalized_atdatetimeOptional

due_atdatetimeOptional

paid_atdatetimeOptional

hosted_payment_urlstringOptionalformat: "uri"

The provider's payment page, once finalized.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error