Sample - Stripe API
POST/v1/issuing/personalization_designs

Create a personalization design

Creates a personalization design that groups a physical bundle with optional card logo and carrier text settings. Supply physical_bundle and optionally set card_logo, carrier_text, lookup_key, name, metadata, or preferences. A 200 response returns the created personalization design with its generated identifier and current status.

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

9 body fields

Form-encoded personalization design details.

card_logostringoptional
The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
carrier_textobjectoptional
Hash containing carrier text, for use with physical bundles that support carrier text.
expandarray<string>optional
Specifies which fields in the response should be expanded.
lookup_keystringoptional
A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
metadataobjectoptional
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
namestringoptional
Friendly display name.
physical_bundlestringrequired
The physical bundle object belonging to this personalization design.
preferencesobjectoptional
Information on whether this personalization design is used to create cards when one is not specified.
transfer_lookup_keybooleanoptional
If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.

2 status codes
200Returns the created personalization design, including its identifier, physical bundle, preferences, metadata, and current status.
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
defaultReturned when the request cannot be processed; the response contains an `error` object with a reason and error type.
errorobjectrequired

Error handling

physical_bundle is required and must identify the physical bundle. card_logo must reference a file with a purpose of issuing_logo, lookup_key and name must be no longer than 200 characters, and preferences.is_default must be provided when preferences is used.