Sample - Stripe API
POST/v1/entitlements/features/{id}

Update an entitlement feature

Updates a feature's metadata or activation state. Use active to deactivate the feature, or provide metadata and name to change its stored information; deactivated features cannot be attached to new products.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 4 body fields
idstringrequired
The feature identifier, limited to 5000 characters.

Optional feature fields to update.

activebooleanoptional
Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
expandarray<string>optional
Specifies which fields in the response should be expanded.
metadataobjectoptional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
The feature's name, for your own purpose, not meant to be displayable to the customer.

2 status codes
200Returns the updated feature object with its activation state, identifier, live-mode state, lookup key, metadata, name, and object type.
activebooleanrequired
Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
lookup_keystringrequired
A unique key you provide as your own system identifier. This may be up to 80 characters.
metadataobjectrequired
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringrequired
The feature's name, for your own purpose, not meant to be displayable to the customer.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:entitlements.feature
defaultReturned when the API cannot process the update; the response contains an error object.
errorobjectrequired

Error handling

id must be a string of no more than 5000 characters. name must not exceed 80 characters, active must be a boolean, and metadata must be an object of string values or an empty string when clearing metadata.