Skip to main content
PATCH
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Partially update an existing subscriptoin. Only provided fields are updated.

metadata
object

Additional metadata for the subscription

charges
object[]
addons
SubscriptionAddon · object[]
trialEndDate
string<date-time>

Subscription trial end date

promotionCode
string

Promotion code

Maximum string length: 255
entitlements
(SubscriptionFeatureEntitlementRequest · object | SubscriptionCreditEntitlementRequest · object)[]

Feature entitlement configuration for a subscription

billingPeriod
enum<string>
Available options:
MONTHLY,
ANNUALLY
awaitPaymentConfirmation
boolean

Await payment confirmation

billingInformation
object
scheduleStrategy
enum<string>
Available options:
END_OF_BILLING_PERIOD,
END_OF_BILLING_MONTH,
IMMEDIATE
budget
object | null
minimumSpend
object | null

Minimum spend amount

priceOverrides
object[]
appliedCoupon
object
billingCycleAnchor
enum<string>
Available options:
UNCHANGED,
NOW
cancellationDate
string<date-time> | null

Subscription cancellation date

salesforceId
string | null

Salesforce ID

Maximum string length: 255

Response

The updated subscription object.

Response object

data
Subscription · object
required

Customer subscription to a plan