api.botsubscription.com

GET/v1/endpoint

AuthenticationBearer

Token

Stays in this tab. Required for this endpoint — the value below is what gets sent.

Path parameters0

Query parameters0

Headers0

BodyJSON

Examples

curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Get Payment Request - View Transaction Details via API

Retrieve a payment request by its ID for reconciliation or customer support.

Read status to determine whether a payment request is complete. An amount of "0" alone does not prove completion.

GET/v2/projects/{project_id}/payment-requests/{payment_request_id}

Authorization

Bearer API KeyRequired

API key access: Unrestricted project API key required. Restricted keys cannot call this endpoint.

Path Parameters

project_idstringrequired

The unique identifier of the project.

payment_request_idstringrequired

The unique identifier of the payment request (UUID).

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/payment-requests/11111111-1111-1111-1111-111111111111" \
  -H "Authorization: Bearer YOUR_API_KEY"

const project_id = 'YOUR_PROJECT_ID';
const payment_request_id = '11111111-1111-1111-1111-111111111111';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/payment-requests/${payment_request_id}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
payment_request_id = '11111111-1111-1111-1111-111111111111'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/payment-requests/{payment_request_id}',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$payment_request_id = '11111111-1111-1111-1111-111111111111';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/payment-requests/{$payment_request_id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_KEY']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Successapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/payment-requests/11111111-1111-1111-1111-111111111111",
  "code": 200,
  "data": {
    "payment_request_id": "11111111-1111-1111-1111-111111111111",
    "merchant_account_id": "22222222-2222-2222-2222-222222222222",
    "amount": "29.99",
    "currency": "USD",
    "status": "completed",
    "request_type": "invoice",
    "created_at": "2024-12-14T10:30:00.000Z",
    "user_id": "123456789012345678",
    "provider": "stripe",
    "provider_payment_id": "pi_3NkQz2ABC123",
    "settled_at": "2024-12-14T10:35:00.000Z",
    "payment_request_data": {},
    "failure_reason": null,
    "payment_error_code": null,
    "plan_id": "22222222-2222-4222-8222-222222222222",
    "plan_name": "Monthly Membership"
  }
}

Payment request not foundapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/payment-requests/11111111-1111-1111-1111-111111111111",
  "code": 404,
  "error": {
    "error_code": "NOT_FOUND",
    "message": "Payment request not found"
  }
}

Invalid or expired API keyapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/payment-requests/22222222-2222-4222-8222-222222222222",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Last updated: November 4, 2026