Skip to main content

​
List Subscriptions

GET /api/v1/subscription/all
Query Parameters:
  • skip (integer): Number of records to skip
  • limit (integer): Max records to return
Response: 
{
  "total": 1,
  "subscriptions": [
    {
      "id": "sub_abc123",
      "account_id": "acc_xyz789",
      "rate_plan_id": "rp_123",
      "status": "active",
      "activated_at": "2024-01-15T10:00:00Z"
    }
  ]
}

​
Create Subscription

POST /api/v1/subscription/create
Body: 
{
  "account_id": "acc_xyz789",
  "rate_plan_id": "rp_123",
  "contract_effective_date": "2024-01-15"
}

​
Get Subscription

GET /api/v1/subscription/{subscription_id}

​
Activate Subscription

POST /api/v1/subscription/{subscription_id}/activate
Activates a draft subscription, making it billable.

​
Cancel Subscription

POST /api/v1/subscription/{subscription_id}/cancel
Body: 
{
  "cancel_date": "2024-12-31",
  "reason": "Customer requested"
}

​
Renew Subscription

POST /api/v1/subscription/{subscription_id}/renew