v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

SubscriptionProduct

List subscription products

Retrieves a list of subscription products with optional filters.

get/v1/subscription-products

Query parameters

channelstring

Filter by payment channel (e.g., PIX)

countrystring

Filter by country code (e.g., BR)

Response

Products retrieved successfully

statusboolean

Indicates if the request was successful

Example response

{
  "data": [
    {
      "retryPolicy": {
        "type": "PIX_SPECIFIC",
        "maxRetries": 5,
        "retryIntervalDays": 2
      },
      "amount": {
        "type": "FIXED",
        "fixedValue": 10000,
        "minValue": 5000,
        "maxValue": 50000,
        "currency": "BRL"
      }
    }
  ]
}