Sample - Stripe API
POST/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate

Deactivate a test-mode personalization design

Deactivates a test-mode personalization design by changing its status to inactive. Provide the personalization_design identifier for the design to deactivate. You can use expand to include additional response fields.

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

1 parameter · 1 body field
personalization_designstringrequired
The unique identifier of the personalization design to deactivate. Must be no longer than 5,000 characters.

Optional form-encoded parameters for expanding fields in the returned personalization design.

expandarray<string>optional
Specifies which fields in the response should be expanded.

2 status codes
200Returns the updated personalization design with `status` set to `inactive`, including its identifier, physical bundle, preferences, rejection reasons, metadata, and other design details.
card_logostringoptional
The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. Image must be in PNG format with dimensions of 1000px by 200px. It must be a binary (black and white) image containing a black logo on a white background. We don't accept grayscale.
carrier_textobjectoptional
Hash containing carrier text, for use with physical bundles that support carrier text.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
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_keystringoptional
A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
Friendly display name.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:issuing.personalization_design
physical_bundlestringrequired
The physical bundle object belonging to this personalization design.
preferencesobjectrequired
rejection_reasonsobjectrequired
statusstringrequired
Whether this personalization design can be used to create cards.
Allowed:activeinactiverejectedreview
defaultReturns an error object containing an `error` property with the error type and related diagnostic information.
errorobjectrequired

Error handling

personalization_design must be a string no longer than 5,000 characters identifying the design to deactivate. If provided, each expand value must be a string no longer than 5,000 characters.