Shows subscription payment details

Request

Retrieves the subscription payment details

Required scope: subscription:read

Security

accountId and apiKey

Path

idstring, (uuid)required

Resource Identification

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

Responses

OK

Bodyapplication/json

idstring, (uuid)

Example:"458b2fc4-3092-4de3-abd4-fe1600c09420"

statusstring

Example:"ok"

keystring

Example:"payment 02536985"

expiration_timestring, (date-time)

Example:"2099-01-15 00:00"

start_timestring, (date-time)

Example:"2027-01-15 00:00"

frequencyany

Enum:"1D""1W""2W""1M""2M""3M""4M""6M""1Y""2Y"

retriesinteger

Example:2

max_capturesinteger

Example:12

failoverboolean

Default:false

capture_nowboolean

unlimited_paymentsboolean

customerobject(customer-response-on-detail)

The Customer object contains detailed information about the customer involved in the transaction.

methodobject(SubscriptionMethodResponseOnDetail)

transactionsArray of objects(payment-transactions)

currencystring(Currency)

ISO 4217 currency code. If not specified, the default currency is set to EUR.

Value:"EUR"

Example:"EUR"

valuenumber, (double)

Example:10.55

created_atstring, (date-time)

Example:"2025-08-05 13:44:29"

Response

Success

{
  "id": "458b2fc4-3092-4de3-abd4-fe1600c09420",
  "key": "subscription 02536985",
  "expiration_time": "2099-01-15 00:00",
  "start_time": "2027-01-15 00:00",
  "frequency": "1M",
  "retries": 2,
  "max_captures": 12,
  "failover": false,
  "capture_now": true,
  "unlimited_payments": false,
  "customer": {
    "id": "e66c4f80-3dc6-11eb-b378-0242ac130002",
    "name": "João Silva",
    "email": "joao.silva@test.com",
    "phone": "+351911234567",
    "fiscal_number": "123456789",
    "key": "customer_key_123",
    "phone_indicators": { … }
  },
  "method": {
    "type": "CC",
    "status": "active",
    "url": "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a",
    "last_four": "2222",
    "card_type": "VISA",
    "expiration_date": "07/29"
  },
  "transactions": [
    { … }
  ],
  "currency": "EUR",
  "value": 10.55,
  "created_at": "2025-08-05 13:44:29"
}