Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks
Sandboxes

Cancel a pricing plan subscription v2

Cancel a PricingPlanSubscription.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    The ID of the PricingPlanSubscription to cancel.

  • cancellation_scheduled_forenum

    Optionally, schedule the PricingPlanSubscription to be canceled in the future.

    Possible enum values
    max_servicing_period_end

    Subscription will be canceled at the latest occuring end of a servicing period.

    min_servicing_period_end

    Subscription will be canceled at the earliest occuring end of a servicing period.

Returns

Response attributes

  • idstring

    Unique identifier for the PricingPlanSubscription.

  • objectstring, value is "v2.billing.pricing_plan_subscription"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • billing_cadencestring

    The ID of the Cadence this subscription is billed on.

  • cancellation_scheduled_fornullable timestamp

    Time at which this subscription will be canceled.

  • collection_statusenum

    Current collection status of this subscription.

    Possible enum values
    awaiting_customer_action

    The subscription payment is pending and requires customer action.

    current

    The subscription is in good standing. All payments have been successfully processed.

    past_due

    The subscription is currently overdue for payment. We are actively attempting to process the payment.

    paused

    Payment collection for the subscription is temporarily paused. The subscription may be resumed in the future, but no payments are being processed at this time.

    unpaid

    All attempts to collect payment for the subscription have been unsuccessful, and the outstanding balance is marked as uncollectible.

  • collection_status_transitionsobject

    Timestamps for collection status transitions.

  • createdtimestamp

    Time at which the object was created.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • metadatanullable map

    Set of key-value pairs that you can attach to an object.

  • pricing_planstring

    The ID of the PricingPlan for this subscription.

  • pricing_plan_versionstring

    The ID of the PricingPlanVersion for this subscription.

  • servicing_statusenum

    Current servicing status of this subscription.

    Possible enum values
    active

    The provisionee of this subscription is receiving servicing.

    canceled

    Servicing for this subscription is canceled.

    paused

    The servicing for the provisionee of this subscription is paused.

    pending

    The subscription is pending a successful payment and is not being serviced yet.

  • servicing_status_transitionsobject

    Timestamps for servicing status transitions.

  • test_clocknullable string

    The ID of the TestClock of the associated Cadence, if any.

Error Codes
400invalid_pricing_plan_subscription_status_for_cancel

Returned when trying to cancel a pricing plan subscription with servicing status canceled.

404pricing_plan_subscription_not_found

Returned when a pricing plan subscription with the provided ID cannot be found.

POST /v2/billing/pricing_plan_subscriptions/:id/cancel
cURL
curl -X POST https://api.stripe.com/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/cancel \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-08-27.preview"
Response
{
  "billing_cadence": "bc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
  "collection_status": "current",
  "collection_status_transitions": {
    "awaiting_customer_action_at": null,
    "current_at": "2024-12-01T00:00:00.000Z",
    "past_due_at": null,
    "paused_at": null,
    "unpaid_at": null
  },
  "created": "2025-01-01T00:00:00.000Z",
  "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
  "metadata": {
    "key": "value"
  },
  "object": "v2.billing.pricing_plan_subscription",
  "pricing_plan": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
  "pricing_plan_version": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
  "servicing_status": "active",
  "servicing_status_transitions": {
    "activated_at": "2024-12-01T00:00:00.000Z",
    "canceled_at": null,
    "paused_at": null
  },
  "test_clock": "clock_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
  "livemode": true
}

PricingPlanSubscription event types v2

This is a list of all public thin events we currently send for updates to PricingPlanSubscription, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type
Filter events by type

Quote 

A Quote is a way to model prices that you’d like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.

Endpoints

Subscriptions 

Subscriptions allow you to charge a customer on a recurring basis.

Related guide: Creating subscriptions

Endpoints

Subscription Items 

Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

Endpoints