Auth
- POSTAnonymous user
- POSTLogin with phone
- POSTLogin with email
- POSTLogin with whatsapp
- POSTLogin with password
- POSTVerify OTP
- POSTRegister with phone
- POSTRegister with email
- POSTRegister with whatsapp
- POSTRegister with password
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate OTP
- POSTLogout user
- POSTCheck email/phone verification status
Catalog
Carts
- POSTCreate cart
- GETRetrieve cart detail
- DELDelete cart
- GETRetrieve cart using user id
- DELDelete cart using user id
- POSTAdd/delete cart item
- POSTUpdate cart address
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
Coupons & promotions
Customers
Orders
Shipping
Analytics
Campaigns
Retrieve subscription details
Retrieve subscription details
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/subscriptions/{id}{
"message": "<string>",
"success": true,
"content": {
"subscription": {
"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",
"invoice_items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"product_name": "<string>",
"variant_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"listing_price": 123,
"selling_price": 123,
"tax_type": "<string>",
"tax_rate": 123,
"price_including_tax": true,
"selling_price_excluding_tax": 123
}
],
"billing_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"shipping_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
}
}
}
}Path Parameters
subscription id
Response
The subscription price is the amount a customer is required to pay over a specified period (e.g., monthly, annually). This price may vary based on the plan selected or based on usage of services.
created, active, paused, revoked if specified, subscrition will be revoked on this date.
If specified, payment will be charged after trial days completed.
monthly Frequency unit multiplier. For example, 1 with monthly means every month; 3 with weekly means in every 3 weeks.
monthly Frequency unit multiplier. For example, 1 with monthly means every month; 3 with weekly means in every 3 weeks.
Indicates how many times a coupon can be redeemed within the subscription.
Indicates whether the subscription is paid in advance. When set to true, the subscription requires the customer to pay for the entire billing period upfront. When set to false, the subscription may operate on a pay-as-you-go or post-paid model, where charges are billed after the service is provided.
Refers to a pricing model where customers are charged based on their actual usage of a service. Usage based billing works for digital products.
The number of days after a failed payment to retry before canceling.
Indcates whether the next billing cancellation is allowed or not.
Specifies the number of days the customer has to cancel before the next billing.
"GST"null value for guest checkout.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
"India"Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
"123456789"
Use in billing & shipping details only.
null value for guest checkout.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
"India"Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
"123456789"
Use in billing & shipping details only.
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/subscriptions/{id}{
"message": "<string>",
"success": true,
"content": {
"subscription": {
"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",
"invoice_items": [
{
"product_id": "<string>",
"variant_id": "<string>",
"product_name": "<string>",
"variant_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"listing_price": 123,
"selling_price": 123,
"tax_type": "<string>",
"tax_rate": 123,
"price_including_tax": true,
"selling_price_excluding_tax": 123
}
],
"billing_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
},
"shipping_address": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"tax_identification_number": "123456789",
"business_name": "<string>",
"is_phone_verified": true,
"is_email_verified": true
}
}
}
}