Skip to main content
GET
/
subscriptions
Get all subscriptions
curl --request GET \
  --url https://api-m.paypal.com/v1/commerce/billing/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "subscriptions": [
    {
      "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6b13234",
      "external_id": "Subscription_1233",
      "plan_code": "Plan-Code-12345",
      "billing_time": "CALENDAR",
      "status": "ACTIVE",
      "start_date": "2025-06-27T20:44:21Z",
      "created_at": "2025-07-30T01:54:40Z",
      "current_period_start": "2025-07-01T00:00:00Z",
      "current_period_end": "2025-07-31T23:59:59Z",
      "id": "d9e9d0c0-d672-4299-8b8e-9d20ca20f465"
    },
    {
      "external_customer_id": "5eb02857-a71e-4ea2-bcf9-1751410090",
      "external_id": "Subscription_123353453453535-2025-07-01T22",
      "plan_code": "Plan-Code-2222",
      "billing_time": "CALENDAR",
      "status": "ACTIVE",
      "start_date": "2025-07-01T22:48:37Z",
      "created_at": "2025-07-30T01:54:40Z",
      "current_period_start": "2025-07-01T22:48:37Z",
      "current_period_end": "2025-07-31T23:59:59Z",
      "id": "35a75733-5940-42cc-97ed-1587d2d364e1"
    }
  ],
  "metadata": {
    "total_count": 24,
    "total_pages": 3,
    "current_page": 1
  }
}

Authorizations

​
Authorization
string
header
required

Use the /v1/oauth2/token endpoint to obtain an access token and pass it as a Bearer token in the Authorization header.

Query Parameters

​
page
integer

Page number

​
per_page
integer

Number of records per page

​
external_customer_id
string

Filter by external customer ID

Example:

"ext_cus_1234567890abcdef"

​
plan_code
string

Filter by plan code

Example:

"plan_1234567890abcdef"

​
status
enum<string>[]

Comma-separated list of statuses

Response

A list of subscriptions

​
subscriptions
object[]
​
metadata
object
⌘I