A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "subscription.collection_scenario",
  "merchant_id": "<string>",
  "subscription_id": "<string>",
  "livemode": false,
  "outcome": "succeeded",
  "consumed": true,
  "created_at": 123,
  "decline_code": "<string>",
  "consumed_at": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Test clocks

Arm the next subscription collection outcome

Configures a one-shot outcome for the next automatic collection attempt on an owned test-mode subscription. The next newly recorded charge attempt consumes the scenario. A retry of that same attempt observes the same result, while a later retry requires a new scenario.

Arm a decline before advancing to a renewal or retry boundary. After Ionic records the failed attempt and schedules the next retry, arm a success and advance to that retry time to verify recovery. Platforms can use the resulting Ionic objects and events to verify access control, notifications, reporting, and connected-account isolation.

Only one unconsumed scenario may exist for a subscription. When no scenario is armed, automatic collection follows the normal test-mode collection path.

POST

test_helpers

subscriptions

{id}

collection_scenarios

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "subscription.collection_scenario",
  "merchant_id": "<string>",
  "subscription_id": "<string>",
  "livemode": false,
  "outcome": "succeeded",
  "consumed": true,
  "created_at": 123,
  "decline_code": "<string>",
  "consumed_at": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Unique key used to replay this mutation safely.

Required string length: 1 - 255

Ionic-Account

string

Connected Ionic account to operate when using an authorized platform credential. Omit when using the account's own credential.

Path Parameters

string

required

Subscription whose next automatic collection attempt will consume the scenario.

Pattern: ^sub_[0-9A-Za-z]{24}$

Body

application/json

outcome

enum<string>

required

Available options:

succeeded,

declined

decline_code

enum<string>

Required for a declined outcome and omitted for a successful outcome.

Available options:

insufficient_funds,

card_velocity_exceeded,

withdrawal_count_limit,

do_not_honor,

generic_decline,

transaction_not_permitted,

expired_card,

incorrect_number,

incorrect_cvc,

duplicate_transaction,

stolen_card,

lost_card,

fraudulent,

pickup_card,

restricted_card,

security_violation,

processing_error,

issuer_not_available,

try_again_later,

processor_declined

Response

The armed one-shot collection scenario.

string<uuid>

required

object

enum<string>

required

Available options:

subscription.collection_scenario

merchant_id

string

required

Pattern: ^mer_[0-9A-Za-z]{14}$

subscription_id

string

required

Pattern: ^sub_[0-9A-Za-z]{24}$

livemode

enum<boolean>

required

Available options:

false

outcome

enum<string>

required

Available options:

succeeded,

declined

consumed

boolean

required

created_at

integer<int64>

required

decline_code

string

consumed_at

integer<int64>

Start here

Checkout

Commerce

Checkout endpoints

Payment link endpoints

Catalog endpoints

Payments

Terminal locations

Terminal management

Terminal testing

Terminal payments

Invoices

Subscriptions

Test clocks

Setup intents

Credit notes

Webhook endpoints

Customer endpoints

API key endpoints

Payment method endpoints

Arm the next subscription collection outcome

Authorizations

Headers

Path Parameters

Body

Response