My Account - Get Single Subscription

Error

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"
    }
  }
}

GET

my-account

subscriptions

{id}

Get specific subscription details

curl --request GET \
  --url {protocol}://{host}/wp-json/cocart/preview/my-account/subscriptions/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "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"
    }
  }
}

This endpoint is currently shown as a preview of what’s currently in development and is subject to change.

This endpoint supports only the official WooCommerce Subscriptions extension.

Authorizations

Authorization

string

header

required

WordPress username and password

Path Parameters

integer

required

Unique identifier for the subscription

Query Parameters

string<email>

The subscription billing email address

Response

Subscription details retrieved successfully

subscription_number

string

Subscription number

Example:

"789"

parent_order

string

Parent order ID

Example:

"456"

order

string<uri>

Link to parent order

Example:

"https://example.com/wp-json/cocart/preview/my-orders/456"

subscription_status

string

Subscription status

Example:

"Active"

is_manual

boolean

Whether subscription requires manual renewal

Example:

false

start_date

object

Show child attributes

start_date.title

string

Date field title

Example:

"Next payment date"

start_date.value

string

Date field value

Example:

"January 15, 2025"

last_order_date_created

object

Show child attributes

last_order_date_created.title

string

Date field title

Example:

"Next payment date"

last_order_date_created.value

string

Date field value

Example:

"January 15, 2025"

next_payment

object

Show child attributes

next_payment.title

string

Date field title

Example:

"Next payment date"

next_payment.value

string

Date field value

Example:

"January 15, 2025"

end_date

object

Show child attributes

end_date.title

string

Date field title

Example:

"Next payment date"

end_date.value

string

Date field value

Example:

"January 15, 2025"

trial_end

object

Show child attributes

trial_end.title

string

Date field title

Example:

"Next payment date"

trial_end.value

string

Date field value

Example:

"January 15, 2025"

payment

object

Show child attributes

payment.title

string

Payment field title

Example:

"Payment"

payment.value

string

Payment field value

Example:

"Credit Card (Stripe)"

billing_address

string

Formatted billing address as comma-separated string

Example:

"John Doe, 123 Main St, Anytown, CA, 12345, US"

shipping_address

string

Formatted shipping address as comma-separated string

Example:

"John Doe, 123 Main St, Anytown, CA, 12345, US"

notes

object[]

Customer-facing subscription notes

Show child attributes

notes.date

string

Note date

notes.note

string

Note content

actions

object

Available subscription actions (view, suspend, reactivate, cancel, etc.)

Show child attributes

actions.{key}

object

Show child attributes

actions.{key}.url

string<uri>

Action URL

actions.{key}.name

string

Action name

My Account - Get Subscriptions

Toggle Subscription Auto-Renewal

⌘I

Overview

JWT Authentication

API v1 (Deprecated in future)

API v2

Plugins

Resources

My Account - Get Single Subscription

Authorizations

Path Parameters

Query Parameters

Response