MINIBC has a fully documented API and Webhook system available to merchants on our API Premium or Enterprise plans.
You can find the API documentation here.
For merchants looking to use webhooks; below are the webhooks available and the data returned for each request.
Webhook Events:
{
"event": "subscriptions.renewal.success",
"data": {
"subscription_ids": [ 10020 ],
"renewal_order_id": 5001
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscriptions.renewal.failed",
"data": {
"subscription_ids": [ 10020 ]
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscription.created",
"data": {
"subscription_id": 10020
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscription.updated",
"data": {
"subscription_id": 10020,
"type": "status",
"from": "active",
"to": "cancelled"
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscription.shipping_address.updated",
"data": {
"subscription_id": 10020
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscription.next_payment.updated",
"data": {
"subscription_id": 10020,
"type": "payment_date",
"original_date": "2021-05-01",
"new_date": "2021-06-27",
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscription.payment_method.updated",
"data": {
"subscription_id": 10020
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscriptions.renewal.batch.completed",
"data": {
"batch_id": 1a2b3c4d
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
{
"event": "subscription.product.updated",
"data": {
"subscription_id": 10020,
"type": "product_id",
"from": 1,
"to": 2,
},
"timestamp": "2023-05-19T02:20:55+00:00"
}
Should you have any questions about our API or wish to upgrade your store, please reach out to our support team.