Skip to main content
GET
/
subscriptions
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/subscriptions/get/clx_sub' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Assinatura encontrada",
  "data": {
    "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_abc123"
}

curl -X GET 'https://api.goatpay.com.br/v1/subscriptions/get/clx_sub' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Assinatura encontrada",
  "data": {
    "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_abc123"
}

​
Envelope da resposta

CampoTipoDescrição
successbooleantrue em sucesso HTTP 2xx
messagestringMensagem legível (ex.: “Transação PIX encontrada”)
dataobjectPayload do recurso (formato abaixo)
requestIdstringID da requisição para suporte (req_...)

​
Status em data.status (assinatura)

StatusSignificado
ACTIVEAssinatura ativa — cobranças geradas a cada ciclo
CANCELEDRecorrência encerrada
INACTIVEInativa

​
Campos em data

CampoDescrição
idID interno GoatPay
providerSubscriptionIdID externo da assinatura
billingTypeForma de pagamento (BOLETO, CREDIT_CARD, etc.)
valueValor de cada ciclo em reais
cycleCiclo de cobrança
nextDueDatePróximo vencimento (ISO 8601)
customerCliente vinculado
planPlano vinculado (se houver)

​
Parâmetros de rota

​
id
string
required
ID interno (clx_...) ou providerSubscriptionId da assinatura.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

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