API
Subscriptions API
Mastercard only
Subscription APIs accept Mastercard. Other providers return 400.
Initiate
POST /subscription/initiate
X-API-KEY: <your-api-key>
Extends payment fields with:
| Field | Type | Notes |
|---|---|---|
user_id | string | Required customer identifier in your system |
payment_provider | string | Must be mastercard |
cycle_config | object | Day-of-month or duration/delay cycle |
renew_option | boolean | Default false |
Day-of-month example: { "day": 1-28, "first_payment": number|null }
Duration example: { "duration": days, "delay": days }
Response includes payment_url, track_id, and related fields.
Manage
| Endpoint | Body |
|---|---|
POST /subscription/cancel | { "track_id" } |
POST /subscription/status | { "track_id" } |
POST /subscription/pause | { "track_id" } |
POST /subscription/resume | { "track_id" } |
POST /subscription/update | { "track_id", "new_amount", "old_amount" } |
Generic responses include success, message, track_id. Status response includes status + track_id.
Subscription statuses: ACTIVE, CANCELED, PENDING, EXPIRED, FAILED, PAUSED, INACTIVE.
Confirm with VenPays that automatic renewals are enabled for your Live account before launching recurring products.