GET
/
v1
/
customer-portal
/
subscriptions
/
import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.subscriptions.list(security=polar_sdk.CustomerPortalSubscriptionsListSecurity(
        customer_session="<YOUR_BEARER_TOKEN_HERE>",
    ), organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737", page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "recurring_interval": "month",
      "status": "incomplete",
      "current_period_start": "2023-11-07T05:31:56Z",
      "current_period_end": "2023-11-07T05:31:56Z",
      "cancel_at_period_end": true,
      "canceled_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "product_id": "<string>",
      "discount_id": "<string>",
      "checkout_id": "<string>",
      "customer_cancellation_reason": "customer_service",
      "customer_cancellation_comment": "<string>",
      "product": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "recurring_interval": "month",
        "is_recurring": true,
        "is_archived": true,
        "organization_id": "<string>",
        "prices": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "amount_type": "<string>",
            "is_archived": true,
            "product_id": "<string>",
            "type": "<string>",
            "recurring_interval": "month",
            "price_currency": "<string>",
            "price_amount": 123,
            "legacy": true
          }
        ],
        "benefits": [
          {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "type": "custom",
            "description": "<string>",
            "selectable": true,
            "deletable": true,
            "organization_id": "<string>"
          }
        ],
        "medias": [
          {
            "id": "<string>",
            "organization_id": "<string>",
            "name": "<string>",
            "path": "<string>",
            "mime_type": "<string>",
            "size": 123,
            "storage_version": "<string>",
            "checksum_etag": "<string>",
            "checksum_sha256_base64": "<string>",
            "checksum_sha256_hex": "<string>",
            "last_modified_at": "2023-11-07T05:31:56Z",
            "version": "<string>",
            "service": "<string>",
            "is_uploaded": true,
            "created_at": "2023-11-07T05:31:56Z",
            "size_readable": "<string>",
            "public_url": "<string>"
          }
        ],
        "organization": {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
          "name": "<string>",
          "slug": "<string>",
          "avatar_url": "<string>",
          "email": "<string>",
          "website": "<string>",
          "socials": [
            {
              "platform": "x",
              "url": "<string>"
            }
          ],
          "details_submitted_at": "2023-11-07T05:31:56Z",
          "feature_settings": {
            "issue_funding_enabled": false,
            "usage_based_billing_enabled": false
          },
          "subscription_settings": {
            "allow_multiple_subscriptions": true,
            "allow_customer_updates": true,
            "proration_behavior": "invoice"
          }
        }
      },
      "prices": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "amount_type": "<string>",
          "is_archived": true,
          "product_id": "<string>",
          "type": "<string>",
          "recurring_interval": "month",
          "price_currency": "<string>",
          "price_amount": 123,
          "legacy": true
        }
      ],
      "meters": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "consumed_units": 25,
          "credited_units": 100,
          "amount": 0,
          "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
          "meter": {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "name": "<string>"
          }
        }
      ]
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

​
Authorization
string
header
required

Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.

Query Parameters

​
organization_id

Filter by organization ID. The organization ID.

Examples:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
product_id

Filter by product ID. The product ID.

​
active
boolean | null

Filter by active or cancelled subscription.

​
query
string | null

Search by product or organization name.

​
page
integer
default:1

Page number, defaults to 1.

Required range: x > 0
​
limit
integer
default:10

Size of a page, defaults to 10. Maximum is 100.

Required range: x > 0
​
sorting
enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

200
application/json

Successful Response

The response is of type object.