v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Subscription

Get subscription details

Retrieves detailed information about a specific subscription.

get/v1/subscriptions/{subscriptionId}

Path parameters

subscriptionIdstring uuid required

Unique identifier of the subscription (UUID format)

Response

Subscription details retrieved successfully

statusboolean

Indicates if the request was successful

Example response

{
  "data": {
    "channel": "PIX",
    "authorizationType": "BACKGROUND",
    "frequency": "MONTHLY",
    "retryPolicy": {
      "type": "PIX_SPECIFIC",
      "maxRetries": 5,
      "retryIntervalDays": 2
    },
    "amount": {
      "type": "FIXED",
      "fixedValue": 10000,
      "minValue": 5000,
      "maxValue": 50000,
      "currency": "BRL"
    },
    "checkout": {
      "payload": {
        "code": "00020126580014br.gov.bcb.pix...",
        "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
      }
    }
  }
}