DELETE
/
v1
/
customer-portal
/
subscriptions
/
{id}
package main

import(
	"context"
	polargo "github.com/polarsource/polar-go"
	"os"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New()

    res, err := s.CustomerPortal.Subscriptions.Cancel(ctx, operations.CustomerPortalSubscriptionsCancelSecurity{
        CustomerSession: os.Getenv("POLAR_CUSTOMER_SESSION"),
    }, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerSubscription != nil {
        // handle response
    }
}
{
  "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>"
      }
    }
  ]
}

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.

Path Parameters

​
id
string
required

The subscription ID.

Response

200
application/json
Customer subscription is canceled.
​
created_at
string
required

Creation timestamp of the object.

​
modified_at
string | null
required

Last modification timestamp of the object.

​
id
string
required

The ID of the object.

​
amount
integer
required

The amount of the subscription.

​
currency
string
required

The currency of the subscription.

​
recurring_interval
enum<string>
required

The interval at which the subscription recurs.

Available options:
month,
year
​
status
enum<string>
required

The status of the subscription.

Available options:
incomplete,
incomplete_expired,
trialing,
active,
past_due,
canceled,
unpaid
​
current_period_start
string
required

The start timestamp of the current billing period.

​
current_period_end
string | null
required

The end timestamp of the current billing period.

​
cancel_at_period_end
boolean
required

Whether the subscription will be canceled at the end of the current period.

​
canceled_at
string | null
required

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

​
started_at
string | null
required

The timestamp when the subscription started.

​
ends_at
string | null
required

The timestamp when the subscription will end.

​
ended_at
string | null
required

The timestamp when the subscription ended.

​
customer_id
string
required

The ID of the subscribed customer.

​
product_id
string
required

The ID of the subscribed product.

​
discount_id
string | null
required

The ID of the applied discount, if any.

​
checkout_id
string | null
required
​
customer_cancellation_reason
enum<string> | null
required
Available options:
customer_service,
low_quality,
missing_features,
switched_service,
too_complex,
too_expensive,
unused,
other
​
customer_cancellation_comment
string | null
required
​
product
object
required
​
prices
object[]
required

List of enabled prices for the subscription.

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

​
meters
object[]
required

List of meters associated with the subscription.