Documentation is still being updated. Some content maybe unfinished.
A valid request URL is required to generate request examples{
"subscription_number": "123",
"parent_order": "456",
"order": "https://example.com/wp-json/cocart/preview/my-account/orders/456",
"subscription_status": "Active",
"is_manual": false,
"start_date": {
"title": "Start date",
"value": "December 15, 2024"
},
"last_order_date_created": {
"title": "Last order date",
"value": "December 15, 2024"
},
"next_payment": {
"title": "Next payment date",
"value": "January 15, 2025"
},
"end_date": {
"title": "End date",
"value": "N/A"
},
"trial_end": {
"title": "Trial end date",
"value": "N/A"
},
"payment": {
"title": "Payment",
"value": "Credit Card (Stripe)"
},
"billing_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"shipping_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"notes": [
{
"date": "December 15, 2024, 2:30pm",
"note": "Subscription activated successfully"
}
],
"actions": {
"suspend": {
"url": "https://example.com/wp-json/cocart/preview/my-account/subscriptions/123/on-hold",
"name": "Suspend"
},
"cancel": {
"url": "https://example.com/wp-json/cocart/preview/my-account/subscriptions/123/cancel",
"name": "Cancel"
}
}
}Retrieve detailed information about a specific customer subscription
A valid request URL is required to generate request examples{
"subscription_number": "123",
"parent_order": "456",
"order": "https://example.com/wp-json/cocart/preview/my-account/orders/456",
"subscription_status": "Active",
"is_manual": false,
"start_date": {
"title": "Start date",
"value": "December 15, 2024"
},
"last_order_date_created": {
"title": "Last order date",
"value": "December 15, 2024"
},
"next_payment": {
"title": "Next payment date",
"value": "January 15, 2025"
},
"end_date": {
"title": "End date",
"value": "N/A"
},
"trial_end": {
"title": "Trial end date",
"value": "N/A"
},
"payment": {
"title": "Payment",
"value": "Credit Card (Stripe)"
},
"billing_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"shipping_address": "John Doe, 123 Main St, Apt 4B, Anytown, CA, 12345, US",
"notes": [
{
"date": "December 15, 2024, 2:30pm",
"note": "Subscription activated successfully"
}
],
"actions": {
"suspend": {
"url": "https://example.com/wp-json/cocart/preview/my-account/subscriptions/123/on-hold",
"name": "Suspend"
},
"cancel": {
"url": "https://example.com/wp-json/cocart/preview/my-account/subscriptions/123/cancel",
"name": "Cancel"
}
}
}WordPress username and password
Unique identifier for the subscription
The subscription billing email address
Subscription details retrieved successfully
Subscription number
"789"
Parent order ID
"456"
Link to parent order
"https://example.com/wp-json/cocart/preview/my-orders/456"
Subscription status
"Active"
Whether subscription requires manual renewal
false
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Formatted billing address as comma-separated string
"John Doe, 123 Main St, Anytown, CA, 12345, US"
Formatted shipping address as comma-separated string
"John Doe, 123 Main St, Anytown, CA, 12345, US"
Customer-facing subscription notes
Show child attributes
Available subscription actions (view, suspend, reactivate, cancel, etc.)
Show child attributes
Was this page helpful?