Skip to navigation

Update plan by external ID

Update a plan by your external plan ID. If attributes are provided, they replace the plan's existing attributes. Set status to archive or restore the plan.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

externalIdstringRequired

Request

Body
namestring or nullOptional
displayNamestring or nullOptional<=250 characters
What your customers see for this plan on invoices, checkout and the customer portal, up to 250 characters. Omit it or send null to use the plan name.
externalIdstring or nullOptional
supportedCurrencieslist of stringsOptional
isDefaultbooleanOptional
statusenumOptional

Set to archived to archive this plan, or active to restore it.

Allowed values:
attributeslist of objectsOptional

Response

200
idstring
productIdstring
namestring or null
displayNamestring or null
What your customers see for this plan on invoices, checkout and the customer portal. Null means they see the plan name.
externalIdstring or null
supportedCurrencieslist of strings
isDefaultboolean
statusenum
Allowed values:
upgradePathOrderdouble or null
archivedAtdatetime or null
createdAtdatetime
updatedAtdatetime
attributeslist of objects

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error