List Subscriptions

GET

/subscriptions

Request

Query Params

owner

string

optional

The owner of the subscriptions to filter by. Only available to admins.

product

string

optional

Find a subscription by its product ID. Returned as a single item list.

limit

number

required

>= 1

offset

number

required

>= 0

include

array[string]

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (Subscription) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Subscription

Example:

Subscription

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

meta

object

optional

total

integer

required

totalWithoutFilters

integer

optional

pages

integer

required

page

integer

required

offset

integer

required

limit

integer

required

totalCount

integer

deprecated

resultCount

integer

deprecated

totalPages

integer

deprecated

currentPage

integer

deprecated

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "Subscription",
            "attributes": {
                "type": "chargebeeSubscription",
                "isActive": true,
                "inTrial": true,
                "trialEndDate": "2019-08-24T14:15:22Z",
                "trialDaysLeft": 0,
                "isTrialUpgradable": true,
                "isTrialCheckoutEnabled": true,
                "startDate": "2019-08-24T14:15:22Z",
                "endDate": "2019-08-24T14:15:22Z",
                "currentBillingPeriodStart": "2019-08-24T14:15:22Z",
                "currentBillingPeriodEnd": "2019-08-24T14:15:22Z",
                "nextInvoiceDate": "2019-08-24T14:15:22Z",
                "isBillingPortalEnabled": true,
                "customerFirstName": "string",
                "customerLastName": "string",
                "customerCardState": "expired",
                "customerPreferredCurrencyCode": "string",
                "customerCardType": "string",
                "customerCardLastFour": "string",
                "customerCardExpiryMonth": 0,
                "customerCardExpiryYear": 0,
                "planName": "string",
                "planAmount": 0,
                "planPriceTag": "string",
                "planIsFree": true,
                "planImageUrl": "string"
            },
            "relationships": {
                "product": {
                    "data": {
                        "id": "FID001",
                        "type": "Product"
                    }
                },
                "owner": {
                    "data": {
                        "id": "FID001",
                        "type": "User"
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ],
    "meta": {
        "total": 0,
        "totalWithoutFilters": 0,
        "pages": 0,
        "page": 0,
        "offset": 0,
        "limit": 0,
        "totalCount": 0,
        "resultCount": 0,
        "totalPages": 0,
        "currentPage": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-08 10:51:21

Get PortalUsage

Get Subscription