List PricingPlanComponents v2

List all PricingPlanComponent objects for a PricingPlan.

Learn more about calling API v2 endpoints.

Parameters

pricing_plan_idstringRequired
The ID of the PricingPlan to list components for.

limitinteger
Optionally set the maximum number of results per page. Defaults to 20.

lookup_keysarray of strings
Filter by lookup keys. Mutually exclusive with pricing_plan_version. You can specify up to 10 lookup keys.

pagestring
A cursor for use in pagination.

pricing_plan_versionstring
The ID of the PricingPlanVersion to list components for. Will use the latest version if not provided. Mutually exclusive with lookup_keys.

Returns

Response attributes

dataarray of objects
List of PricingPlanComponents.

next_page_urlnullable string
The URL to get the next page of results, if there are any.

previous_page_urlnullable string
The URL to get the previous page of results, if there are any.

Error Codes

404pricing_plan_not_found

Returned when the provided pricing_plan ID cannot be found.

404pricing_plan_version_not_found

Returned when the provided pricing_plan_version ID cannot be found.

GET /v2/billing/pricing_plans/:id/components

Server-side language

curl https://api.stripe.com/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/components \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview"

Response

{
  "data": [
    {
      "created": "2025-01-01T00:00:00.000Z",
      "id": "bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "lookup_key": "monthly-fee-component",
      "metadata": {
        "key": "value"
      },
      "object": "v2.billing.pricing_plan_component",
      "pricing_plan": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "pricing_plan_version": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "type": "license_fee",
      "livemode": true,
      "license_fee": {
        "id": "licf_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
        "version": "licfv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
      }
    }
  ],
  "next_page_url": null,
  "previous_page_url": null
}

List PricingPlans v2

List all PricingPlan objects.

Learn more about calling API v2 endpoints.

Parameters

activeboolean
Filter for active/inactive PricingPlans. Mutually exclusive with lookup_keys.

limitinteger
Optionally set the maximum number of results per page. Defaults to 20.

lookup_keysarray of strings
Filter by lookup keys. Mutually exclusive with active. You can specify up to 10 lookup keys.

pagestring
A cursor for use in pagination.

Returns

Response attributes

dataarray of objects
List of PricingPlans.

next_page_urlnullable string
The URL to get the next page of results, if there are any.

previous_page_urlnullable string
The URL to get the previous page of results, if there are any.

GET /v2/billing/pricing_plans

Server-side language

curl https://api.stripe.com/v2/billing/pricing_plans \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview"

Response

{
  "data": [
    {
      "active": true,
      "created": "2025-01-01T00:00:00.000Z",
      "currency": "usd",
      "display_name": "Pro Pricing Plan",
      "id": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "latest_version": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "live_version": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "lookup_key": "pro-pricing-plan",
      "metadata": {
        "key": "value"
      },
      "object": "v2.billing.pricing_plan",
      "tax_behavior": "exclusive",
      "livemode": true
    }
  ],
  "next_page_url": null,
  "previous_page_url": null
}

List PricingPlanVersions v2

List all versions of a PricingPlan.

Learn more about calling API v2 endpoints.

Parameters

pricing_plan_idstringRequired
The ID of the PricingPlan to list versions for.

limitinteger
Optionally set the maximum number of results per page. Defaults to 20.

pagestring
A cursor for use in pagination.

Returns

Response attributes

dataarray of objects
List of PricingPlanVersions.

next_page_urlnullable string
The URL to get the next page of results, if there are any.

previous_page_urlnullable string
The URL to get the previous page of results, if there are any.

Error Codes

404pricing_plan_not_found

Returned when the provided pricing_plan ID cannot be found.

GET /v2/billing/pricing_plans/:id/versions

Server-side language

curl https://api.stripe.com/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/versions \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview"

Response

{
  "data": [
    {
      "created": "2025-01-01T00:00:00.000Z",
      "end_date": "2025-12-31T23:59:59.000Z",
      "id": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "object": "v2.billing.pricing_plan_version",
      "pricing_plan": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
      "start_date": "2025-01-01T00:00:00.000Z",
      "livemode": true
    }
  ],
  "next_page_url": null,
  "previous_page_url": null
}

Delete a PricingPlanComponent v2

Remove a PricingPlanComponent from the latest version of a PricingPlan.

Learn more about calling API v2 endpoints.

Parameters

idstringRequired
The ID of the PricingPlanComponent to remove.

pricing_plan_idstringRequired
The ID of the PricingPlan.

Returns

Response attributes

idstring
The ID of the PricingPlanComponent that was removed.

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

Error Codes

400pricing_plan_component_delete_inactive

Returned when trying to remove a pricing plan component that is not available in the latest pricing plan version.

400pricing_plan_inactive

Returned when trying to create or modify a subscription for an inactive pricing plan.

404pricing_plan_component_not_found

Returned when the provided pricing_plan_component ID cannot be found.

404pricing_plan_not_found

Returned when the provided pricing_plan ID cannot be found.

DELETE /v2/billing/pricing_plans/:id/components/:id

Server-side language

curl -X DELETE https://api.stripe.com/v2/billing/pricing_plans/bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy/components/bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview"

Response

{
  "id": "bppc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
  "object": "v2.billing.pricing_plan_component"
}

Pricing Plan Subscriptions v2

A PricingPlanSubscription links a PricingPlan to a specific billing Cadence. While the PricingPlanSubscription is active, Stripe will bill the Payer according to the PricingPlan’s components.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/billing/intents

POST/v2/billing/pricing_plan_subscriptions/:id

GET/v2/billing/intents/:id

GET/v2/billing/pricing_plan_subscriptions/:id

GET/v2/billing/pricing_plan_subscriptions

POST/v2/billing/pricing_plan_subscriptions/:id/cancel

POST/v2/billing/intents/:id/commit

POST/v2/billing/intents/:id/reserve