Subscriptions
Subscription endpoints support programmatic lifecycle workflows and agent/MCP integrations.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/subscriptions | List subscriptions |
| POST | /v1/subscriptions | Create subscription workflow |
| GET | /v1/subscriptions/:id | Get subscription |
| PUT/PATCH | /v1/subscriptions/:id | Update subscription |
| DELETE | /v1/subscriptions/:id | Cancel subscription |
| POST | /v1/subscriptions/:id/pause | Pause subscription |
| POST | /v1/subscriptions/:id/resume | Resume subscription |
| GET | /v1/subscriptions/events | Subscription event stream |
List
curl "https://api.oilpriceapi.com/v1/subscriptions" \
-H "Authorization: Token YOUR_API_KEY"
{
"status": "success",
"data": [
{
"id": "sub_123",
"plan": "professional",
"status": "active",
"current_period_end": "2026-08-01T00:00:00Z"
}
]
}
Pause / Resume
curl -X POST "https://api.oilpriceapi.com/v1/subscriptions/sub_123/pause" \
-H "Authorization: Token YOUR_API_KEY"
curl -X POST "https://api.oilpriceapi.com/v1/subscriptions/sub_123/resume" \
-H "Authorization: Token YOUR_API_KEY"
Events
curl "https://api.oilpriceapi.com/v1/subscriptions/events" \
-H "Authorization: Token YOUR_API_KEY"
Use events to reconcile lifecycle actions, billing transitions, and agent-run automation.
Error Cases
| Status | When |
|---|---|
401 | Missing or invalid API key |
403 | Subscription action not allowed |
404 | Subscription id not found |
422 | Invalid lifecycle transition |