Skip to main content
PATCH
Update Plan
Update a plan. Every field is editable, price and cadence included.
Changing a plan only affects new subscribers. Everyone already subscribed keeps the terms copied onto their subscription when they signed up. To move someone onto current pricing, call Apply current plan terms.

Request authentication

This endpoint requires a Secret Key (sk_...).

Request parameters

Send only the fields you want to change.
string
What customers see on the plan.
number
The new price for new subscribers.
string
The fiat currency the plan is priced in.
string
day, week, month or year.
integer
Bill every N intervals.
integer
A free trial before the first charge.
integer
Days after a period ends that a subscriber can still pay. Between 0 and 30.
string
invoice only for now. auto_debit and both are coming soon.

Authorizations

x-api-key
string
header
required

Path Parameters

planId
string
required

Body

application/json
name
string
Example:

"Pro monthly"

description
string
amount
number
Example:

49

currency
string
default:USD
Example:

"USD"

interval
enum<string>
Available options:
day,
week,
month,
year
interval_count
integer
default:1
Example:

1

trial_days
integer
default:0
Example:

14

grace_days
integer
default:7

Days after a period ends that a subscriber can still pay before the subscription expires.

Required range: 0 <= x <= 30
Example:

7

collection_mode
enum<string>
default:invoice

Only invoice is accepted today. auto_debit (pull against an approved on-chain allowance) is coming soon; sending it is rejected.

Available options:
invoice
metadata
object

Response

The updated plan. Existing subscribers keep the terms they signed up on.

A single plan.

message
string
data
object