Skip to main content

​
Recurring Billing Endpoints

This section provides detailed information about all endpoints and schemas related to recurring billing operations.

​
Available Endpoints

The Recurring Billing API provides the following endpoints for provider operations:

​
Core Operations

  • Primary Endpoints: Main functionality endpoints
  • Status Endpoints: Health and status checking
  • Configuration Endpoints: Settings and configuration management

​
Advanced Operations

  • Batch Endpoints: Bulk processing capabilities
  • Reporting Endpoints: Analytics and reporting
  • Webhook Endpoints: Event notification management

​
Authentication

All endpoints require authentication via Bearer token: 
curl -X GET "https://api.peere.network/v1/endpoint" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

​
Request/Response Format

​
Standard Request Format

{
  "parameter1": "value1",
  "parameter2": "value2",
  "metadata": {}
}

​
Standard Response Format

{
  "statusCode": 200,
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "result": "operation_result",
    "metadata": {}
  }
}

​
Error Responses

​
Common Error Formats

​
400 Bad Request

{
  "statusCode": 400,
  "success": false,
  "message": "Invalid request parameters",
  "errors": [
    "Parameter 'field' is required",
    "Invalid format for 'field'"
  ]
}

​
401 Unauthorized

{
  "statusCode": 401,
  "success": false,
  "message": "Authentication required"
}

​
403 Forbidden

{
  "statusCode": 403,
  "success": false,
  "message": "Insufficient permissions"
}

​
429 Rate Limited

{
  "statusCode": 429,
  "success": false,
  "message": "Rate limit exceeded",
  "retryAfter": 60
}

​
Code Examples

​
JavaScript

async function callEndpoint(parameters) {
  try {
    const response = await fetch('https://api.peere.network/v1/endpoint', {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify(parameters)
    });
    
    const data = await response.json();
    
    if (data.success) {
      return data.data;
    } else {
      throw new Error(data.message);
    }
  } catch (error) {
    console.error('API call failed:', error);
    throw error;
  }
}

​
Python

import requests

def call_endpoint(parameters):
    url = "https://api.peere.network/v1/endpoint"
    headers = {
        'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
        'Content-Type': 'application/json'
    }
    
    try:
        response = requests.post(url, json=parameters, headers=headers)
        data = response.json()
        
        if data.get('success'):
            return data.get('data')
        else:
            raise Exception(data.get('message', 'API call failed'))
    except Exception as e:
        print(f"Error calling API: {e}")
        raise

​
cURL

curl -X POST "https://api.peere.network/v1/endpoint" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "parameter1": "value1",
    "parameter2": "value2"
  }'

​
Rate Limits

Endpoint TypeRate LimitBurst Limit
Standard Operations100 requests/minute10 requests/second
Batch Operations10 requests/minute2 requests/second
Status Checks300 requests/minute30 requests/second

​
Data Schemas

​
Request Schemas

Detailed schemas for request payloads are available in the OpenAPI specification.

​
Response Schemas

All response schemas follow consistent patterns with proper error handling and data validation.

​
Webhooks

Some operations support webhook notifications for real-time updates:

​
Webhook Configuration

{
  "webhookUrl": "https://your-domain.com/webhooks",
  "events": ["operation.completed", "operation.failed"],
  "secret": "your_webhook_secret"
}

​
Webhook Payload

{
  "event": "operation.completed",
  "timestamp": "2024-01-01T00:00:00Z",
  "data": {
    "operationId": "op_123",
    "status": "completed",
    "result": {}
  }
}

​
Testing

​
Sandbox Environment

Test your integration using our sandbox environment:
  • Base URL: https://sandbox-api.peere.network
  • Test Credentials: Available in your developer dashboard
  • Mock Data: Realistic test data for comprehensive testing

​
Testing Best Practices

  • Test all error scenarios
  • Validate webhook handling
  • Test rate limiting behavior
  • Verify data validation

​
Support

For technical support and questions:
  • Documentation: Comprehensive API documentation
  • Support Portal: 24/7 technical support
  • Community: Developer community forums
  • Status Page: Real-time service status updates