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_•••'

List Payment Requests

Get all payment transactions for your subscription bot. Each payment request record includes the amount, currency, status (pending, completed, failed), payment provider details, and timestamps. Use pagination to efficiently query large transaction histories.

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

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.

Query Parameters

user_idstring

Filter to one customer's platform user ID. Requires payment-history:read permission.

limitinteger

Number of items per page. Default: 50

offsetinteger

Number of items to skip. Default: 0

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/payment-requests?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

const project_id = 'YOUR_PROJECT_ID';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/payment-requests?limit=10&offset=0`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/payment-requests',
    params={'limit': 10, 'offset': 0},
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/payment-requests?limit=10&offset=0");
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",
  "code": 200,
  "total": 2,
  "message": "Payment requests fetched successfully",
  "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_id": "33333333-3333-3333-3333-333333333333",
      "merchant_account_id": "22222222-2222-2222-2222-222222222222",
      "amount": "49.99",
      "currency": "USD",
      "status": "pending",
      "request_type": "invoice",
      "created_at": "2024-12-15T08:00:00.000Z",
      "user_id": "987654321098765432",
      "provider": "stripe",
      "provider_payment_id": "pi_3NkQz2DEF456",
      "settled_at": null,
      "payment_request_data": {},
      "failure_reason": null,
      "payment_error_code": null,
      "plan_id": "22222222-2222-4222-8222-222222222222",
      "plan_name": "Monthly Membership"
    }
  ]
}

Invalid page limitapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/payment-requests",
  "code": 422,
  "errors": [
    {
      "message": "query: limit is too small; minimum allowed is 1",
      "error_code": "VALIDATION_ERROR"
    }
  ]
}

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",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Last updated: November 4, 2026