Skip to main content
GET
/
subscriptions
/
list
curl -X GET 'https://api.goatpay.com.br/v1/subscriptions/list' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'
{
  "success": true,
  "message": "Lista de assinaturas",
  "data": {
    "items": [{
    "id": "clx_sub",
    "providerSubscriptionId": "sub_ext_xyz",
    "status": "ACTIVE",
    "cycle": "MONTHLY",
    "billingType": "BOLETO",
    "value": 99.9,
    "description": "Plano Premium",
    "nextDueDate": "2026-08-01T00:00:00.000Z",
    "createdAt": "2026-07-01T12:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Maria Silva",
      "taxId": "12345678909"
    },
    "plan": {
      "id": "clx_plan",
      "name": "Plano Premium"
    }
  }]
  },
  "requestId": "req_abc"
}
curl -X GET 'https://api.goatpay.com.br/v1/subscriptions/list' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'
{
  "success": true,
  "message": "Lista de assinaturas",
  "data": {
    "items": [{
    "id": "clx_sub",
    "providerSubscriptionId": "sub_ext_xyz",
    "status": "ACTIVE",
    "cycle": "MONTHLY",
    "billingType": "BOLETO",
    "value": 99.9,
    "description": "Plano Premium",
    "nextDueDate": "2026-08-01T00:00:00.000Z",
    "createdAt": "2026-07-01T12:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Maria Silva",
      "taxId": "12345678909"
    },
    "plan": {
      "id": "clx_plan",
      "name": "Plano Premium"
    }
  }]
  },
  "requestId": "req_abc"
}

Authorizations

X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Query Parameters

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:50
Required range: 1 <= x <= 100
status
string
Example:

"ACTIVE"

cycle
string
Example:

"MONTHLY"

method
string
Example:

"BOLETO"

Response

Operação concluída.

success
boolean
required
Example:

true

message
string
required
Example:

"Operação concluída com sucesso"

data
object
required
requestId
string