Retrieve a cycle on a subscription

Request

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: subscription:read

Security

accountId and apiKey

Path

idstring, (uuid)required

UUID of the subscription the cycle belongs to.

cycle_idstring, (uuid)required

UUID of the cycle to retrieve.

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/subscription/{id}/cycle/{cycle_id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json

idstring, (uuid)required

The cycle's unique identifier.

Example:"550e8400-e29b-41d4-a716-446655440000"

typestringrequired

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.

Enum:"RENEWABLE""ONE_TIME_CHARGE""CAPTURE_NOW"

Example:"RENEWABLE"

statusstringrequired

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.

Enum:"PENDING""PROCESSING""WAITING""SUCCESS""FAILED""RETRY""FAILOVER""DELETED"

Example:"PENDING"

valuenumber, (double), >= 0required

The amount captured, in euros.

Example:10.5

capture_atstring, (date-time)required

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

Example:"2026-05-22T09:00:00Z"

descriptionstring, <= 255 characters

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

Example:"monthly charge"

keystring, <= 50 characters

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

Example:"my-key"

Response

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