ποΈ Commerce
- Catalog
- Carts
- Coupons & Promotions
- Orders
- Shipping
- Payments
- Subscriptions
π Customers
- Auth
- Customers
- KYC
ποΈ Engagement & Retention
- Campaigns
- Analytics
π§° Utilities
- Common
Subscriptions
List all subscriptions
List all subscriptions
GET
/
subscriptions
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/subscriptions
{
"message": "<string>",
"success": true,
"content": {
"subscriptions": [
{
"id": "<string>",
"plan_id": "<string>",
"plan_name": "<string>",
"price": 123,
"status": "created",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"trial_days": 0,
"trial_start_date": "2023-12-25",
"trial_end_date": "2023-12-25",
"next_billing_date": "2023-12-25",
"last_payment_date": "2023-11-07T05:31:56Z",
"pause_start_date": "2023-12-25",
"pause_end_date": "2023-12-25",
"billing_frequency": "monthly",
"billing_interval": 1,
"billing_limit": 123,
"shipping_frequency": "monthly",
"shipping_interval": 1,
"shipping_limit": 123,
"coupon_id": "<string>",
"coupon_code": "<string>",
"coupon_discount_percent": 0,
"coupon_discount_amount": 0,
"coupon_redemption_limit": 0,
"is_prepaid": false,
"usage_based_billing": true,
"usage_based_tiers": [
{
"up_to": 123,
"price_per_unit": 123
}
],
"grace_period_days": 0,
"is_cancellation_allowed": true,
"days_until_cancellation_allowed": 3,
"currency": {
"name": "Indian Rupee",
"code": "INR",
"symbol": "βΉ"
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
}
}
Response
200 - application/json
OK
The response is of type object
.
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/subscriptions
{
"message": "<string>",
"success": true,
"content": {
"subscriptions": [
{
"id": "<string>",
"plan_id": "<string>",
"plan_name": "<string>",
"price": 123,
"status": "created",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"trial_days": 0,
"trial_start_date": "2023-12-25",
"trial_end_date": "2023-12-25",
"next_billing_date": "2023-12-25",
"last_payment_date": "2023-11-07T05:31:56Z",
"pause_start_date": "2023-12-25",
"pause_end_date": "2023-12-25",
"billing_frequency": "monthly",
"billing_interval": 1,
"billing_limit": 123,
"shipping_frequency": "monthly",
"shipping_interval": 1,
"shipping_limit": 123,
"coupon_id": "<string>",
"coupon_code": "<string>",
"coupon_discount_percent": 0,
"coupon_discount_amount": 0,
"coupon_redemption_limit": 0,
"is_prepaid": false,
"usage_based_billing": true,
"usage_based_tiers": [
{
"up_to": 123,
"price_per_unit": 123
}
],
"grace_period_days": 0,
"is_cancellation_allowed": true,
"days_until_cancellation_allowed": 3,
"currency": {
"name": "Indian Rupee",
"code": "INR",
"symbol": "βΉ"
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total_records": 252,
"total_pages": 26,
"previous_page": null,
"next_page": 2,
"limit": 10
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.