Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Subscription Payment

Shows subscription payment details

Retrieves the subscription payment details

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

get/subscription/{id}

Path parameters

idstring uuid required

Resource Identification

Response

OK

idstring uuid
statusstring
keystring
expiration_timestring date-time
start_timestring date-time
frequency'1D' | '1W' | '2W' | '1M' | '2M' | '3M' | '4M' | '6M' | '1Y' | '2Y' | '3Y'
retriesinteger
max_capturesinteger
failoverboolean
capture_nowboolean
unlimited_paymentsboolean
currency'EUR'

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

valuenumber double
created_atstring date-time

Example response

{
  "id": "458b2fc4-3092-4de3-abd4-fe1600c09420",
  "status": "ok",
  "key": "payment 02536985",
  "expiration_time": "2099-01-15 00:00",
  "start_time": "2027-01-15 00:00",
  "retries": 2,
  "max_captures": 12,
  "customer": {
    "id": "1b4ca1cf-9a1a-415b-97bf-342c6ddcf9c1",
    "name": "Joey Price",
    "email": "john.doe@yahoo.com",
    "phone": "911234567",
    "phone_indicative": "+351",
    "fiscal_number": "PT921839198892623010",
    "key": "subscription 01234589",
    "language": "PT"
  },
  "method": {
    "url": "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a",
    "last_four": "2222",
    "card_type": "VISA",
    "expiration_date": "07/29",
    "sdd_mandate": {
      "id": "50389142122",
      "iban": "PT50002700000001234567833",
      "key": "Sdd mandate Key Example",
      "name": "John Doe",
      "email": "john.doe@easypay.pt",
      "phone": "911345678",
      "account_holder": "John Doe",
      "country_code": "PT",
      "max_num_debits": "12",
      "billing_entity": "PT16103627",
      "reference_adc": "987654321123"
    }
  },
  "transactions": [
    {
      "id": "4fb3ac57-c7fe-4157-aeb7-4362ae24deec",
      "key": "Merchant identification key",
      "created_at": "2025-05-30T17:21:46Z",
      "date": "2025-05-30T17:21:47Z",
      "values": {
        "requested": 12.55,
        "paid": 12.55,
        "fixed_fee": 0.07,
        "variable_fee": 0.09,
        "tax": 0.04,
        "transfer": 12.35
      },
      "transfer_date": "2025-06-02T00:00:00Z",
      "method": "mbw",
      "document_number": "MARCEL0208220628294020250530172147",
      "descriptive": "Descriptive Josefa"
    }
  ],
  "currency": "EUR",
  "value": 10.55,
  "created_at": "2025-08-05 13:44:29"
}