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>"
}
}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.
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique key used to replay this mutation safely.
1 - 255Connected Ionic account to operate when using an authorized platform credential. Omit when using the account's own credential.
Path Parameters
Subscription whose next automatic collection attempt will consume the scenario.
^sub_[0-9A-Za-z]{24}$Body
Result the next automatic collection attempt for the subscription returns.
succeeded, declined Required for a declined outcome and omitted for a successful outcome.
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.
Unique identifier for the collection scenario.
subscription.collection_scenario ID of the account that owns the scenario (mer_…).
^mer_[0-9A-Za-z]{14}$ID of the subscription the scenario applies to (sub_…).
^sub_[0-9A-Za-z]{24}$false Result the next automatic collection attempt for the subscription returns.
succeeded, declined Whether a collection attempt has used the scenario. A scenario is used by one attempt only.
Unix epoch seconds when the scenario was created.
Decline code the attempt returns. Present only when outcome is declined.
Unix epoch seconds when a collection attempt used the scenario. Present only when consumed is true.