Terminate a subscription

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
EXTERNAL_ID="__YOUR_SUBSCRIPTION_ID__"

curl --location --request DELETE "$LAGO_URL/api/v1/subscriptions/$EXTERNAL_ID?status=pending" \
  --header "Authorization: Bearer $API_KEY"

from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError

client = Client(api_key='__YOUR_API_KEY__')

try:
    client.subscriptions.destroy('external_id')
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception

require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')
client.subscriptions.destroy("5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba")

await client.subscriptions.destroySubscription("external_id");

import "fmt"
import "github.com/getlago/lago-go-client"

func main() {
lagoClient := lago.New().
    SetApiKey("__YOUR_API_KEY__")

subscription, err := lagoClient.Subscription().Terminate("__EXTERNAL_ID__")
if err != nil {
    // Error is *lago.Error
    panic(err)
}

// subscription is *lago.Subscription
fmt.Println(subscription)
}

{
  "subscription": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "billing_time": "anniversary",
    "name": "Repository A",
    "plan_code": "premium",
    "status": "active",
    "created_at": "2022-08-08T00:00:00Z",
    "canceled_at": "2022-09-14T16:35:31Z",
    "started_at": "2022-08-08T00:00:00Z",
    "ending_at": "2022-10-08T00:00:00Z",
    "subscription_at": "2022-08-08T00:00:00Z",
    "terminated_at": "2022-09-14T16:35:31Z",
    "previous_plan_code": null,
    "next_plan_code": null,
    "downgrade_plan_date": "2022-04-30",
    "trial_ended_at": "2022-08-08T00:00:00Z",
    "current_billing_period_started_at": "2022-08-08T00:00:00Z",
    "current_billing_period_ending_at": "2022-09-08T00:00:00Z",
    "on_termination_credit_note": "credit",
    "on_termination_invoice": "generate",
    "billing_entity_code": "default",
    "plan_amount_cents": 10000,
    "plan_amount_currency": "USD",
    "applied_invoice_custom_sections": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "created_at": "2023-07-06T14:35:58Z",
        "invoice_custom_section": {
          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "name": "EU Bank Details",
          "code": "eu_bank_details",
          "description": "This section contains the bank details for EU customers.",
          "details": "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143",
          "display_name": "Bank Details:",
          "applied_to_organization": true,
          "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "created_at": "2023-07-06T14:35:58Z"
        },
        "invoice_custom_section_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
      }
    ],
    "payment_method": {
      "payment_method_type": "provider",
      "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
    },
    "consolidate_invoice": true,
    "cancellation_reason": "payment_failed",
    "activated_at": "2022-08-08T00:00:00Z",
    "activation_rules": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "type": "payment",
        "timeout_hours": 48,
        "status": "pending",
        "created_at": "2022-08-08T00:00:00Z",
        "updated_at": "2022-08-08T00:00:00Z",
        "expires_at": "2022-08-10T00:00:00Z"
      }
    ],
    "purchase_order_number": "PO-123"
  }
}

{
  "status": 401,
  "error": "Unauthorized"
}

{
  "status": 404,
  "error": "Not Found",
  "code": "object_not_found"
}

{
  "status": 422,
  "error": "Unprocessable entity",
  "code": "validation_errors",
  "error_details": {}
}

DELETE

subscriptions

{external_id}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
EXTERNAL_ID="__YOUR_SUBSCRIPTION_ID__"

curl --location --request DELETE "$LAGO_URL/api/v1/subscriptions/$EXTERNAL_ID?status=pending" \
  --header "Authorization: Bearer $API_KEY"

from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError

client = Client(api_key='__YOUR_API_KEY__')

try:
    client.subscriptions.destroy('external_id')
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception

require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')
client.subscriptions.destroy("5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba")

await client.subscriptions.destroySubscription("external_id");

import "fmt"
import "github.com/getlago/lago-go-client"

func main() {
lagoClient := lago.New().
    SetApiKey("__YOUR_API_KEY__")

subscription, err := lagoClient.Subscription().Terminate("__EXTERNAL_ID__")
if err != nil {
    // Error is *lago.Error
    panic(err)
}

// subscription is *lago.Subscription
fmt.Println(subscription)
}

{
  "subscription": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "billing_time": "anniversary",
    "name": "Repository A",
    "plan_code": "premium",
    "status": "active",
    "created_at": "2022-08-08T00:00:00Z",
    "canceled_at": "2022-09-14T16:35:31Z",
    "started_at": "2022-08-08T00:00:00Z",
    "ending_at": "2022-10-08T00:00:00Z",
    "subscription_at": "2022-08-08T00:00:00Z",
    "terminated_at": "2022-09-14T16:35:31Z",
    "previous_plan_code": null,
    "next_plan_code": null,
    "downgrade_plan_date": "2022-04-30",
    "trial_ended_at": "2022-08-08T00:00:00Z",
    "current_billing_period_started_at": "2022-08-08T00:00:00Z",
    "current_billing_period_ending_at": "2022-09-08T00:00:00Z",
    "on_termination_credit_note": "credit",
    "on_termination_invoice": "generate",
    "billing_entity_code": "default",
    "plan_amount_cents": 10000,
    "plan_amount_currency": "USD",
    "applied_invoice_custom_sections": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "created_at": "2023-07-06T14:35:58Z",
        "invoice_custom_section": {
          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "name": "EU Bank Details",
          "code": "eu_bank_details",
          "description": "This section contains the bank details for EU customers.",
          "details": "Bank Name: Lago Bank, IBAN: FR7630004000031234567890143",
          "display_name": "Bank Details:",
          "applied_to_organization": true,
          "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "created_at": "2023-07-06T14:35:58Z"
        },
        "invoice_custom_section_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
      }
    ],
    "payment_method": {
      "payment_method_type": "provider",
      "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
    },
    "consolidate_invoice": true,
    "cancellation_reason": "payment_failed",
    "activated_at": "2022-08-08T00:00:00Z",
    "activation_rules": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "type": "payment",
        "timeout_hours": 48,
        "status": "pending",
        "created_at": "2022-08-08T00:00:00Z",
        "updated_at": "2022-08-08T00:00:00Z",
        "expires_at": "2022-08-10T00:00:00Z"
      }
    ],
    "purchase_order_number": "PO-123"
  }
}

{
  "status": 401,
  "error": "Unauthorized"
}

{
  "status": 404,
  "error": "Not Found",
  "code": "object_not_found"
}

{
  "status": 422,
  "error": "Unprocessable entity",
  "code": "validation_errors",
  "error_details": {}
}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
EXTERNAL_ID="__YOUR_SUBSCRIPTION_ID__"

curl --location --request DELETE "$LAGO_URL/api/v1/subscriptions/$EXTERNAL_ID?status=pending" \
  --header "Authorization: Bearer $API_KEY"

from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError

client = Client(api_key='__YOUR_API_KEY__')

try:
    client.subscriptions.destroy('external_id')
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception

require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')
client.subscriptions.destroy("5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba")

await client.subscriptions.destroySubscription("external_id");

import "fmt"
import "github.com/getlago/lago-go-client"

func main() {
lagoClient := lago.New().
    SetApiKey("__YOUR_API_KEY__")

subscription, err := lagoClient.Subscription().Terminate("__EXTERNAL_ID__")
if err != nil {
    // Error is *lago.Error
    panic(err)
}

// subscription is *lago.Subscription
fmt.Println(subscription)
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

external_id

string

required

External ID of the existing subscription

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

Query Parameters

status

string

default:active

Selects which subscription to terminate for the given external_id, based on its status. If the field is not defined, Lago targets only active subscriptions.

pending: cancel a subscription scheduled for a future activation (include status=pending).
incomplete: cancel a payment-gated subscription that is still awaiting its activation payment (include status=incomplete). The subscription is canceled with cancellation_reason: manual, its invoice is closed and nothing is billed, and any pending payment is canceled on a best-effort basis with the payment provider (some provider statuses cannot be canceled). Applied coupons, credit notes and wallet credits are recredited. Termination behaviours (on_termination_credit_note, on_termination_invoice) are ignored, as an incomplete subscription has never been billed.

Example:

"incomplete"

on_termination_credit_note

enum<string>

When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default. This field allows you to control the behavior of the credit note generation:

credit: A credit note is generated for the unused subscription time. The unused amount is credited back to the customer.
refund: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is credited back to the customer.
skip: No credit note is generated for the unused subscription time.

Note: This field is only applicable to pay-in-advance plans and is ignored for pay-in-arrears plans.

Available options:

credit,

refund,

skip

Example:

"credit"

on_termination_invoice

enum<string>

When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage. This field allows you to control the behavior of the invoice generation:

generate: An invoice is generated for the unbilled usage.
skip: No invoice is generated for the unbilled usage.

Available options:

generate,

skip

Example:

"generate"

Response

Subscription terminated

subscription

object

required

Show child attributes