Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Subscription Payment

Updates subscription payment details

Updates the subscription payment details

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

patch/subscription/{id}

Path parameters

idstring uuid required

Resource Identification

Request body

status'active' | 'inactive'

The Subscription Status.</br> When sets to inactive the next pending cycles will be deleted.</br> When sets to active a new billing cycle will be schedule accordingly the new frequency and start_time.</br> Those properties are required to active a subscription.

expiration_timestring Y-m-d H:i
currency'EUR'

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

keystring

The merchant's key for identifying the payment.

valuenumber double

The payment value.</br>Will be rounded to 2 decimals.

frequency'1D' | '1W' | '2W' | '1M' | '2M' | '3M' | '4M' | '6M' | '1Y' | '2Y' | '3Y'

Defining the frequency that the cycles are charged.

max_capturesinteger

Defining the total of cycles that will be charged.</br> When this property is set, unlimited_payments will be inactivated.

unlimited_paymentsboolean

When this property is set, unlimited cycles will be charged until the subscription is inactivated or deleted.

start_timestring Y-m-d H:i

Defining the start of billing cycles.

failoverboolean

After all retries failed, the payment cycle can have another try with another single method.

retriesinteger

Number of retries in each payment cycle.</br> The chosen frequency will define the max number of possible retries.

Example request

{
  "status": "active",
  "expiration_time": "2039-12-12 16:05",
  "currency": "EUR",
  "customer": {
    "name": "Jonh Doe",
    "email": "customer@example.com",
    "phone": "962496235",
    "phone_indicative": "351",
    "fiscal_number": "PT277712580",
    "key": "01J1PKR2RPHJNJQGFWGDYXY0KM",
    "language": "PT"
  },
  "key": "Example Key",
  "value": 12.55,
  "start_time": "2025-12-12 16:05",
  "sdd_mandate": {
    "iban": "PT50002700000001234567833",
    "key": "Sdd mandate Key Example",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "911234567",
    "account_holder": "John Doe",
    "country_code": "PT",
    "max_num_debits": "12",
    "billing_entity": "PT16103627"
  }
}

Response

OK

statusstring

Example response

{
  "status": "ok",
  "message": {
    "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"
  }
}