Stripe: Retrieve a personalization design

Stripe issuing.getIssuingPersonalizationDesignsPersonalizationDesign: arguments, response, policy and SDK examples.

Operation stripe.getissuingpersonalizationdesignspersonalizationdesign

Provider route: GET /v1/issuing/personalization_designs/{personalization_design}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["issuing"]["getIssuingPersonalizationDesignsPersonalizationDesign"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issuing.getIssuingPersonalizationDesignsPersonalizationDesign(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issuing.get_issuing_personalization_designs_personalization_design(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.personalization_design`	string	Required within parent	Maximum length: 5000
`query`	object	Optional	Additional keys: not allowed
`query.expand`	array	Optional
`query.expand[]`	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Create a personalization design — response body

Referenced models: Create a personalization design — response body

Schemas

5 more schemas are linked from the tables above, on the schema pages.

Create a personalization design — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
`card_logo`	JSON	Optional
`card_logo (anyOf 1)`	JSON	Alternative	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.
`card_logo (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`card_logo (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a file — response body
`card_logo (anyOf 2)`	null	Alternative
`carrier_text`	JSON	Optional
`carrier_text (anyOf 1)`	JSON	Alternative	Hash containing carrier text, for use with physical bundles that support carrier text.
`carrier_text (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a personalization design — response body — carrier text value footer body, footer title, header body, header title
`carrier_text (anyOf 2)`	null	Alternative
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`lookup_key`	JSON	Optional
`lookup_key (anyOf 1)`	string	Alternative	A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. Maximum length: 5000
`lookup_key (anyOf 2)`	null	Alternative
`metadata`	object	Required within parent	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. Additional keys: see wildcard field
`metadata.*`	string	Additional keys	Maximum length: 500
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	Friendly display name. Maximum length: 5000
`name (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.personalization_design
`physical_bundle`	JSON	Required within parent	The physical bundle object belonging to this personalization design.
`physical_bundle (anyOf 1)`	string	Alternative	Maximum length: 5000
`physical_bundle (anyOf 2)`	Model	Alternative	Expand Retrieve a physical bundle — response body
`preferences`	Model	Required within parent	Expand Create a personalization design — response body — preferences
`rejection_reasons`	Model	Required within parent	Expand Create a personalization design — response body — rejection reasons
`status`	string	Required within parent	Whether this personalization design can be used to create cards. Known values: active, inactive, rejected, review

Referenced models: Create a file — response body, Retrieve a physical bundle — response body, Create a personalization design — response body — carrier text value footer body, footer title, header body, header title, Create a personalization design — response body — preferences, Create a personalization design — response body — rejection reasons

Create a file — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://docs.stripe.com/api#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](#scheduled_queries)). Related guide: [File upload guide](https://docs.stripe.com/file-upload)
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`expires_at`	JSON	Optional
`expires_at (anyOf 1)`	JSON	Alternative
`expires_at (anyOf 1) (anyOf 1)`	integer	Alternative	The file expires and isn't available at this time in epoch seconds. Format: unix-time
`expires_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`expires_at (anyOf 2)`	null	Alternative
`filename`	JSON	Optional
`filename (anyOf 1)`	string	Alternative	The suitable name for saving the file to a filesystem. Maximum length: 5000
`filename (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`links`	JSON	Optional
`links (anyOf 1)`	object	Alternative	A list of [file links](https://docs.stripe.com/api#file_links) that point at this file.
`links (anyOf 1).data`	array	Required within parent	Details about each object.
`links (anyOf 1).data[]`	Model	Each item	Expand Create a file link — response body
`links (anyOf 1).has_more`	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
`links (anyOf 1).object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
`links (anyOf 1).url`	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/file_links
`links (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: file
`purpose`	string	Required within parent	The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. Known values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, financial_account_statement, identity_document, identity_document_downloadable, issuing_regulatory_reporting, pci_document, platform_terms_of_service, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_android_apk, terminal_reader_splashscreen, terminal_wifi_certificate, terminal_wifi_private_key
`size`	JSON	Required within parent
`size (anyOf 1)`	integer	Alternative	The size of the file object in bytes.
`size (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`title`	JSON	Optional
`title (anyOf 1)`	string	Alternative	A suitable title for the document. Maximum length: 5000
`title (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). Maximum length: 5000
`type (anyOf 2)`	null	Alternative
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative	Use your live secret API key to download the file from this URL. Maximum length: 5000
`url (anyOf 2)`	null	Alternative

Referenced models: Create a file link — response body

Retrieve a physical bundle — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
`features`	Model	Required within parent	Expand Retrieve a physical bundle — response body — features
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`name`	string	Required within parent	Friendly display name. Maximum length: 5000
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.physical_bundle
`status`	string	Required within parent	Whether this physical bundle can be used to create cards. Known values: active, inactive, review
`type`	string	Required within parent	Whether this physical bundle is a standard Stripe offering or custom-made for you. Known values: custom, standard

Referenced models: Retrieve a physical bundle — response body — features

Policy, approvals and errors

SDK function policy ID: stripe.getissuingpersonalizationdesignspersonalizationdesign. Catalog operation: GetIssuingPersonalizationDesignsPersonalizationDesign. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page