curl -X GET 'https://api.wovepay.com/v1/subscriptions/get/sub_abc123' \
-H 'X-API-Key: wp_live_SUA_CHAVE'
{
"success": true,
"message": "Assinatura encontrada",
"data": {
"subscriptionId": "sub_abc123",
"externalId": "sub_ext_xyz",
"status": "ACTIVE",
"method": "BOLETO",
"amount": 99.9,
"cycle": "MONTHLY",
"description": "Plano Premium",
"nextDueDate": "2026-08-01",
"createdAt": "2026-07-01T12:00:00.000Z",
"customer": {
"id": "12345678909",
"name": "Maria Silva",
"taxId": "12345678909"
}
},
"requestId": "req_abc123"
}
Consultar assinatura
Por subscriptionId interno (sub_...) ou externalId do provider.
GET
/
subscriptions
/
get
/
{id}
curl -X GET 'https://api.wovepay.com/v1/subscriptions/get/sub_abc123' \
-H 'X-API-Key: wp_live_SUA_CHAVE'
{
"success": true,
"message": "Assinatura encontrada",
"data": {
"subscriptionId": "sub_abc123",
"externalId": "sub_ext_xyz",
"status": "ACTIVE",
"method": "BOLETO",
"amount": 99.9,
"cycle": "MONTHLY",
"description": "Plano Premium",
"nextDueDate": "2026-08-01",
"createdAt": "2026-07-01T12:00:00.000Z",
"customer": {
"id": "12345678909",
"name": "Maria Silva",
"taxId": "12345678909"
}
},
"requestId": "req_abc123"
}
curl -X GET 'https://api.wovepay.com/v1/subscriptions/get/sub_abc123' \
-H 'X-API-Key: wp_live_SUA_CHAVE'
{
"success": true,
"message": "Assinatura encontrada",
"data": {
"subscriptionId": "sub_abc123",
"externalId": "sub_ext_xyz",
"status": "ACTIVE",
"method": "BOLETO",
"amount": 99.9,
"cycle": "MONTHLY",
"description": "Plano Premium",
"nextDueDate": "2026-08-01",
"createdAt": "2026-07-01T12:00:00.000Z",
"customer": {
"id": "12345678909",
"name": "Maria Silva",
"taxId": "12345678909"
}
},
"requestId": "req_abc123"
}
Status em data.status
| Status | Significado |
|---|---|
| ACTIVE | Assinatura ativa — cobranças geradas a cada ciclo |
| CANCELED | Recorrência encerrada |
| INACTIVE | Inativa |
| EXPIRED | Expirada |
Campos em data
| Campo | Descrição |
|---|---|
| subscriptionId | ID interno WovePay (sub_...) |
| externalId | ID externo da assinatura no provider |
| method | BOLETO, CARD_CREDIT ou PIX |
| amount | Valor de cada ciclo em reais |
| cycle | Ciclo de cobrança |
| nextDueDate | Próximo vencimento (YYYY-MM-DD) |
| customer | Cliente vinculado |
Parâmetros de rota
string
required
subscriptionId interno (sub_...) ou externalId do provider.Authorizations
Chave wp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)