Subscription Status

GET https://api-sandbox.epag.io/subscriptions/SUBSCRIPTION_ID

This HTTP GET request is used to get the status of a Subscription using the PIX Automático scheme.

Authorization

Header	Value
X-Auth-Token	MY_ACCESS_TOKEN

Example Request

Success

Success

    curl --location 'https://api-sandbox.epag.io/subscriptions/SUBSCRIPTION_ID'

Example Response

Header

  Content-Type: application/json

200 OK

  {
    "id": "cc6effd7-2100-47ee-b483-5b4ac719f97d",
    "reference_id": "MY_REFERENCE_ID",
    "status": "ACTIVE",
    "created_at": "2025-10-01T12:34:56.123",
    "error_code": null,
    "error_description": null,
    "start_date": "2025-10-05",
    "end_date": null,
    "periodicity": "WEEKLY",
    "force_work_day": true,
    "merchant_initiation": false,
    "order_amount": "100.00",
    "order_currency": "BRL",
    "payment_country": "BR",
    "payment_currency": "BRL",
    "amount_type": "FIXED",
    "scheme": "PIX_AUTOMATICO",
    "retry_policy": "NOT_ALLOW",
    "minimum_amount": 1
  }