Update a billing subscription

put

https://app.pennylane.com/api/external/v2/billing_subscriptions/{id}

This endpoint requires the following scope: billing_subscriptions:all

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The ID of the billing subscription to retrieve

Query Params

use_2026_api_changes

boolean

Defaults to true

If you are already using the X-Use-2026-API-Changes header, you can ignore this parameter.

The Pennylane API is introducing important changes, which will be rolled out in three phases: preview, sunset and cleanup.

For new user, please use this parameter with true value to opt in directly to the new version of the API.

Preview phase: From January 14th to April 7th 2026. Opt in by setting this attribute to true to test and migrate to the new behavior.

Sunset phase: From April 8th to June 30th 2026. The new behavior becomes the default. Set this attribute to false if you need additional time to migrate.

Cleanup phase: Starting July 1st 2026 The old behavior will no longer be available. You must have migrated by this point.

For more details, see our API documentation https://pennylane.readme.io/docs/2026-api-changes-guide for migration instructions.

Body Params

stop

boolean

To stop an in_progress billing subscription use value true. To resume a stopped billing subscription use value false

mode

object

payment_conditions

string

enum

payment_method

string

enum

Payment method offline means the subscription is not linked to a payment method gocardless_direct-debit means at each new occurrence the client will be automatically debited thanks to GoCardless. To do so, you need a GoCardless account properly configured.

Allowed:

label

string | null

recurring_rule

object

customer_id

int64

Customer identifier

customer_invoice_data

object

Responses

200Renders the updated billing subscription

400Bad request

401Access token is missing or invalid

403Access to this resource forbidden

404The resource was not found

422Unprocessable content