Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Subscription Payment

Retrieve a cycle on a subscription

Returns a single cycle that belongs to the given subscription. A cycle that doesn't exist — or that belongs to a different account — returns 404 Not Found.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">subscription:read</code>

get/subscription/{id}/cycle/{cycle_id}

Path parameters

idstring uuid required

UUID of the subscription the cycle belongs to.

cycle_idstring uuid required

UUID of the cycle to retrieve.

Response

OK

idstring uuid required

The cycle's unique identifier.

type'RENEWABLE' | 'ONE_TIME_CHARGE' | 'CAPTURE_NOW' required

How the cycle was created:

  • RENEWABLE — part of the recurring schedule.
  • ONE_TIME_CHARGE — an ad-hoc capture added on top of the schedule.
  • CAPTURE_NOW — an immediate one-off capture.
status'PENDING' | 'PROCESSING' | 'WAITING' | 'SUCCESS' | 'FAILED' | 'RETRY' | 'FAILOVER' | 'DELETED' required

The current state of the cycle:

  • PENDING — queued, waiting for its scheduled time.
  • PROCESSING — capture is being executed right now.
  • WAITING — waiting on an external dependency (e.g. customer action).
  • SUCCESS — captured successfully.
  • FAILED — capture failed and will not be retried.
  • RETRY — capture failed but is queued for another attempt.
  • FAILOVER — switched to the failover method after the primary failed.
  • DELETED — cancelled before being captured.
valuenumber double required

The amount captured, in euros.

capture_atstring date-time required

When the capture is scheduled to run, in UTC (RFC 3339).

descriptionstring

Free-form text shown on the bank statement or in the MB WAY app. Omitted when not set.

keystring

Your internal identifier for the cycle. Omitted when not set.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "RENEWABLE",
  "status": "PENDING",
  "value": 10.5,
  "capture_at": "2026-05-22T09:00:00Z",
  "description": "monthly charge",
  "key": "my-key"
}