curl --request POST \
  --url https://api.sandbox.z2pay.com/v1/subscriptions/{id}/pause \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reasonDetails": "<string>",
  "resumesAt": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reasonDetails: '<string>', resumesAt: '2023-11-07T05:31:56Z'})
};

fetch('https://api.sandbox.z2pay.com/v1/subscriptions/{id}/pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.z2pay.com/v1/subscriptions/{id}/pause"

payload = {
    "reasonDetails": "<string>",
    "resumesAt": "2023-11-07T05:31:56Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "sub_hsm2kigu74htdxj3nw2z6f9xw",
  "number": {
    "sequence": 42
  },
  "referenceCode": "CONTRATO-2026-0042",
  "customerId": "cust_c72q6ogr9iko0we85mqal04te",
  "customerEmail": "maria.silva@example.com",
  "customerName": "Maria Silva",
  "customerDocument": "12345678909",
  "currency": "BRL",
  "status": "paused",
  "billingGroupId": null,
  "currentPeriodStart": "2025-06-01T03:00:00.000Z",
  "currentPeriodEnd": "2025-07-01T03:00:00.000Z",
  "nextInvoiceAt": "2025-07-01T03:00:00.000Z",
  "recurrence": {
    "interval": 1,
    "unit": "month",
    "anchor": "day_of_month",
    "anchorDay": 1,
    "collectionTiming": "prepaid"
  },
  "collectionMethod": "charge_automatically",
  "collectionTiming": "prepaid",
  "invoiceGenerationMode": "just_in_time",
  "cancelAtPeriodEnd": false,
  "canceledAt": null,
  "endedAt": null,
  "cancellationReason": null,
  "pausedAt": "2025-06-29T13:45:30.000Z",
  "pauseResumesAt": "2025-08-29T03:00:00.000Z",
  "pauseReason": "cust_request",
  "trialEnd": null,
  "incompleteExpiresAt": null,
  "trialRemindersFired": [],
  "maxCycles": null,
  "issuedCycles": 1,
  "completedCycles": 1,
  "defaultPaymentMethodRef": {
    "id": "crd_tsj66oabsygc9kwvvzt8189f9",
    "type": "card"
  },
  "splitConfig": null,
  "paymentBehavior": "allow_incomplete",
  "latestInvoiceId": "inv_c3qahi4qnkc258lfc14gplupt",
  "paymentUpdateToken": null,
  "paymentUpdateMethods": null,
  "metadata": {},
  "createdAt": "2025-06-01T13:45:30.000Z",
  "updatedAt": "2025-06-29T13:45:30.000Z"
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "issues": [
      {
        "path": "status",
        "message": "Status inválido. Valores aceitos: pending, waiting_payment, paid, refused, canceled, refunded"
      },
      {
        "path": "startDate",
        "message": "Data deve ser ISO 8601 com timezone (ex.: 2026-06-24T00:00:00Z)"
      }
    ]
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Subscription not found"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "No refundable payment found"
  }
}

{
  "error": "Idempotency key already used with a different request body"
}