Stripe

https://docs.stripe.com
Admin
Stripe is a financial services and software as a service company that provides payment processing...
Tokens:2,965,468
Snippets:23,250
Trust Score:10
Update:6 days ago
Show doc for...
Tokens:
Raw
### Install dependencies and start Node server

Source: https://docs.stripe.com/samples/identity/redirect

Navigate to the server directory, install required npm dependencies, and start the local application server.

```shell
cd server/ # there's a README in this folder with instructions
npm install
npm start
```

--------------------------------

### Configure onboarding post_install_action

Source: https://docs.stripe.com/stripe-apps/post-install-actions

Direct users to complete setup tasks before using your app by launching the onboarding flow immediately after installation.

```json
{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "permissions": [],
  "app_backend": {},
  "ui_extension": {},
  "post_install_action": {
    "type": "onboarding"
  }
}
```

--------------------------------

### Build and run the Ruby sample server

Source: https://docs.stripe.com/docs/payments/quickstart

Installs dependencies using Bundler and starts the Ruby server listening on all host interfaces. Ensure {{PRICE_ID}} is replaced with a valid Stripe Price ID in the server code before launching.

```shell
bundle install
```

```shell
ruby server.rb -o 0.0.0.0
```

--------------------------------

### Build the sample server with bundle install

Source: https://docs.stripe.com/docs/payments/quickstart-checkout-sessions

Installs the required Ruby dependencies for running the sample application.

```shell
bundle install
```

--------------------------------

### GET /v2/money_management/outbound_setup_intents

Source: https://docs.stripe.com/keys/permissions-reference

List outbound setup intents. Requires the `v2_account_merchant_read` permission.

```APIDOC
## GET /v2/money_management/outbound_setup_intents

### Description
Allows listing outbound setup intents.

### Method
GET

### Endpoint
`/v2/money_management/outbound_setup_intents`

### Required Permission
`v2_account_merchant_read`
```

--------------------------------

### Start the Ruby server

Source: https://docs.stripe.com/docs/payments/quickstart-checkout-sessions

Starts the local server. Once running, navigate to http://localhost:4242/checkout.html to test the checkout flow.

```shell
ruby server.rb
```

--------------------------------

### Inspect requirements.alternatives example response

Source: https://docs.stripe.com/connect/upcoming-requirements-updates

Shows example structure of `alternative_fields_due` and `original_fields_due` for fulfilling owner verification requirements.

```json

{
  "alternative_fields_due": [
    "company.owners_provided",
    "documents.proof_of_ultimate_beneficial_ownership.files",
    "owners.first_name",
    "owners.last_name"
  ],
  "original_fields_due": [
    "company.owners_provided",
    "owners.first_name",
    "owners.last_name"
  ]
}

```

--------------------------------

### Start Stripe Terminal quickstart

Source: https://docs.stripe.com/cli/additional_commands

Run the quickstart command to get up and running with Stripe Terminal and the Verifone P400 reader. Note that this command only supports the --api-key flag.

```shell
stripe terminal quickstart
```

--------------------------------

### Collect and confirm setup intent (Legacy two-step)

Source: https://docs.stripe.com/terminal/references/sdk-v5-migration-guide

Demonstrates the two-step setup intent flow using collectSetupIntentPaymentMethod and confirmSetupIntent.

```Swift

// Step 1: Collect setup intent payment method
Terminal.shared.collectSetupIntentPaymentMethod(setupIntent, customerConsentCollected: true) { collectedSetupIntent, collectError in
    guard let collectedSetupIntent = collectedSetupIntent else {
        // Setup intent collection failed
        return
    }
    // Step 2: Confirm the setup intent
    Terminal.shared.confirmSetupIntent(collectedSetupIntent) { confirmedSetupIntent, confirmError in
        if let confirmedSetupIntent = confirmedSetupIntent {
            // Setup intent successful
        } else {
            // Setup intent confirmation failed
        }
    }
}

```

--------------------------------

### Install the Stripe Crypto SDK using Yarn

Source: https://docs.stripe.com/crypto/onramp/embedded-components-integration-guide

Installs the `@stripe/crypto` package as an alternative package manager setup using Yarn.

```bash
yarn add @stripe/crypto
```

--------------------------------

### Example App Install API resource payload

Source: https://docs.stripe.com/stripe-apps/events

Represents the App Install resource object returned in apps.install.created and apps.install.updated webhook events.

```json
{
  "object": {
    "object": "apps.install",
    "id": "appinst_1234",
    "account": "acct_1234",
    "app": "app_1234",
    "permissions_granted": [],
    "content_security_policy_granted": {
      "connect_src": [],
      "image_src": []
    },
    "channel": "public",
    "created": 123,
    "livemode": true,
    "status": "installed"
  }
}
```

--------------------------------

### Create a Checkout Session with installments enabled using cURL

Source: https://docs.stripe.com/payments/jp-installments/accept-a-payment

Creates a Checkout session in payment mode with card installments enabled. Note that installments only work with payment mode, not setup or subscription mode.

```bash
curl https://api.stripe.com/v1/checkout/sessions \
  -u "sk_test_...:" \
  --data-urlencode "success_url=https://example.com/success" \
  -d "line_items[0][price]={{PRICE_ID}}" \
  -d "line_items[0][quantity]=3" \
  -d mode=payment \
  -d "payment_method_options[card][installments][enabled]=true"
```

--------------------------------

### Retrieve SetupIntent and View Example Response

Source: https://docs.stripe.com/payments/checkout/subscriptions/update-payment-details

Retrieves the SetupIntent object using its ID to obtain the customer ID, subscription_id, and payment_method ID. Shows both the cURL request and the example JSON response.

```bash

curl https://api.stripe.com/v1/setup_intents/
{{SETUP_INTENT_ID}}
 \
  -u "sk_test_...:"

```

```json

{
  "id": "seti_1EzVO3HssDVaQm2PJjXHmLlM",
  "object": "setup_intent",
  "application": null,
  "cancellation_reason": null,
  "client_secret": null,
  "created": 1561420781,
  "customer": "cus_FOsk5sbh3ZQpAU",
  "description": null,
  "last_setup_error": null,
  "livemode": false,
  "metadata": {
    "subscription_id": "sub_8epEF0PuRhmltU"
  },
  "next_action": null,
  "on_behalf_of": null,
  "payment_method": "pm_1F0c9v2eZvKYlo2CJDeTrB4n",
  "payment_method_types": [
    "card"
  ],
  "status": "succeeded",
  "usage": "off_session"
}

```

--------------------------------

### The Meter Event Summary object example

Source: https://docs.stripe.com/api/billing/meter-event-summary/list

Represents an example of a billing.meter_event_summary object containing aggregated usage within minute-aligned start and end timestamps.

```json
{
  "id": "mtrusg_test_6041CMAXJrFdZ56U76ce6L35Hz7xA3Tn58z5sY7bq6gM3XN5bx5Y459D4Xt2E17ko6M86kt7kV3bl5PM7LV59l4sY50b6oU5QD7bY3HP58z5sY7bq6gM3Y57LF2Dr7od3Hb8927gh4Tt4Lo4xO4ge60T81C6Y53gl4QS2D33ft3HC3Xi3Cy3Cy3Cy",
  "object": "billing.meter_event_summary",
  "aggregated_value": 10,
  "end_time": 1711659600,
  "livemode": false,
  "meter": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA",
  "start_time": 1711656000
}
```

--------------------------------

### Create a SetupIntent to save a card server-side

Source: https://docs.stripe.com/payments/cards/save-and-reuse

Sets setup_credential_usage to declare intended usage after creating a customer.

```bash

curl https://api.stripe.com/v1/setup_intents \
  -u "sk_test_...:" \
  -d "customer=
{{CUSTOMER_ID}}
" \
  -d "automatic_payment_methods[enabled]=true" \
  -d "payment_method_options[card][setup_credential_usage]=unscheduled"

```

--------------------------------

### GET /v2/money_management/outbound_setup_intents/{id}

Source: https://docs.stripe.com/keys/permissions-reference

Retrieve an outbound setup intent. Requires the `v2_account_merchant_read` permission.

```APIDOC
## GET /v2/money_management/outbound_setup_intents/{id}

### Description
Allows retrieving an outbound setup intent by ID.

### Method
GET

### Endpoint
`/v2/money_management/outbound_setup_intents/{id}`

### Required Permission
`v2_account_merchant_read`
```

--------------------------------

### Start the Ruby sample server

Source: https://docs.stripe.com/docs/payments/quickstart-checkout-sessions

Runs the local server bound to host 0.0.0.0. Once running, access the checkout page at http://localhost:4242/checkout.html.

```shell
ruby server.rb -o 0.0.0.0
```

--------------------------------

### Navigate to app directory

Source: https://docs.stripe.com/stripe-apps/create-app

Change into the created `helloworld` project directory before running commands.

```shell
cd helloworld
```

--------------------------------

### Create a SetupIntent with a BankAccount

Source: https://docs.stripe.com/payments/ach-direct-debit/migrating-from-charges

Pass the ID of a saved BankAccount as the payment_method parameter when creating a SetupIntent.

```bash
curl https://api.stripe.com/v1/setup_intents \
  -u "sk_test_...:" \
  -d "customer_account=
{{CUSTOMER_ACCOUNT_ID}}
" \
  -d "payment_method=
{{BANK_ACCOUNT_ID}}
" \
  -d "allowed_payment_method_types[]=us_bank_account"
```

--------------------------------

### Example issuing_transaction.created webhook payload

Source: https://docs.stripe.com/issuing/agents

Payload received when subscribing to issuing_transaction.created to get notifications when a charge settles, containing metadata to match against original orders.

```json
{
 "type": "issuing_transaction.created",
 "data": {
   "object": {
     "amount": 7500,
     "merchant_data": { "name": "Logistics Co", "category_code": "4215" },
     "card": {
       "metadata": {
         "customer_order_id": "order_8821",
         "agent_id": "agent_fulfillment_01"
       }
     }
   }
 }
}
```

--------------------------------

### List persons using cURL

Source: https://docs.stripe.com/api/v2/core/persons/create

Send a GET request to retrieve a paginated list of Persons associated with an Account. Includes the corresponding JSON response example.

```bash
curl https://api.stripe.com/v2/core/accounts/{{ACCOUNT_ID}}/persons \
  -H "Authorization: Bearer sk_test_...sk_test_..." \
  -H "Stripe-Version: 2026-09-30.endive"
```

```json
{
  "data": [
    {
      "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY",
      "object": "v2.core.account_person",
      "account": "acct_1Nv0FGQ9RKHgCVdK",
      "additional_addresses": [],
      "additional_names": [],
      "address": {
        "city": "Brothers",
        "country": "us",
        "line1": "27 Fredrick Ave",
        "postal_code": "97712",
        "state": "OR"
      },
      "created": "2024-11-26T17:10:07.000Z",
      "date_of_birth": {
        "day": 28,
        "month": 1,
        "year": 2000
      },
      "email": "jenny.rosen@example.com",
      "given_name": "Jenny",
      "id_numbers": [
        {
          "type": "us_ssn_last_4"
        }
      ],
      "livemode": true,
      "metadata": {},
      "nationalities": [],
      "relationship": {
        "owner": true,
        "percent_ownership": "0.8",
        "representative": true,
        "title": "CEO"
      },
      "surname": "Rosen",
      "updated": "2024-11-26T17:12:55.000Z"
    }
  ]
}
```

--------------------------------

### Process SetupIntent with MOTO configuration

Source: https://docs.stripe.com/terminal/features/mail-telephone-orders/save-directly

Send the SetupIntent to the reader by calling process_setup_intent with process_config[moto] set to true and specifying allow_redisplay. This initiates an asynchronous prompt on the reader for card details.

```curl
curl https://api.stripe.com/v1/terminal/readers/
{{READER_ID}}
/process_setup_intent \
  -u "sk_test_...:" \
  -d "setup_intent=
{{SETUP_INTENT_ID}}
" \
  -d "process_config[moto]=true" \
  -d allow_redisplay=always
```

--------------------------------

### stripe agent setup

Source: https://docs.stripe.com/cli/resources_http_commands

Configures AI coding agent tooling by detecting supported agent harnesses and installing Stripe plugins, skills, and MCP servers.

```APIDOC
## stripe agent setup [flags]

### Description
Set up tooling to help AI coding agents use Stripe. This command detects common agent harnesses and installs the relevant Stripe plugin, skills, and MCP server. Supports Claude Code, Codex, and Cursor.

### Usage
```bash
stripe agent setup [flags]
```

### Flags
- **--client** (string) - Limit setup to a specific client. Supports `claude-code`, `codex`, and `cursor`.
- **--force** (boolean) - Reinstall agent tooling even if it's already installed.
- **--json** (boolean) - Print machine-readable status and planned actions without making changes.
- **--skills** (boolean) - Install Stripe skills directly, without an interactive prompt.
- **--skills-scope** (string) - Select where to install Stripe skills. Use `local` for the current directory or `global` for your home directory. Default is `local`.
- **--status** (boolean) - See the currently installed agent tooling.
- **-y, --yes** (boolean) - Skip interactive prompts and set up all detected clients.

### Example
```bash
stripe agent setup
```
```

--------------------------------

### Create a SetupIntent via cURL

Source: https://docs.stripe.com/payments/au-becs-debit/set-up-payment

Create a SetupIntent on your server specifying the customer account and enabling automatic payment methods. The returned SetupIntent contains a client_secret to pass to the client-side application.

```bash
curl https://api.stripe.com/v1/setup_intents \
  -u sk_test_...: \
  -d "customer_account"="{{CUSTOMER_ACCOUNT_ID}}" \
  -d "automatic_payment_methods[enabled]"="true"
```

--------------------------------

### POST /subscription/withSetupIntent

Source: https://docs.stripe.com/use-stripe-apps/commercetools-connect/use-subscriptions

Creates a subscription with a trial setup on a commercetools product.

```APIDOC
## POST /subscription/withSetupIntent

### Description
Create a subscription with trial setup on a commercetools product.

### Method
POST

### Endpoint
/subscription/withSetupIntent
```

--------------------------------

### stripe agent setup

Source: https://docs.stripe.com/cli/webhooks

Configures tooling for AI coding agents to interact with Stripe by detecting client harnesses and installing plugins, skills, and MCP servers.

```APIDOC
## stripe agent setup

### Description
Set up tooling to help AI coding agents use Stripe. This command detects common agent harnesses and installs the relevant Stripe plugin, skills, and MCP server. Supports Claude Code, Codex, and Cursor.

### Usage
```bash
stripe agent setup [flags]
```

### Flags
- **--client <client>** (string) - Optional - Limit setup to a specific client. Supports `claude-code`, `codex`, and `cursor`.
- **--force** (boolean) - Optional - Reinstall agent tooling even if it's already installed.
- **--json** (boolean) - Optional - Print machine-readable status and planned actions without making changes.
- **--skills** (boolean) - Optional - Install Stripe skills directly, without an interactive prompt.
- **--skills-scope <scope>** (string) - Optional - Select where to install Stripe skills (`local` for the current directory or `global` for your home directory). Default is `local`.
- **--status** (boolean) - Optional - See the currently installed agent tooling.
- **-y, --yes** (boolean) - Optional - Skip interactive prompts and set up all detected clients.

### Examples
```bash
stripe agent setup
```
```

--------------------------------

### Create a SetupIntent for US bank account repayments using cURL

Source: https://docs.stripe.com/issuing/consumer-issuing/integrate

Sets up a SetupIntent with a US bank account token to prepare for future ACH repayments. Save the PaymentMethod ID returned in the response for subsequent repayment processing.

```bash
curl https://api.stripe.com/v1/setup_intents \
  -u "{{SECRET_KEY}}:" \
  -d customer={{CUSTOMER_ID}} \
  -d "payment_method_data[type]"=us_bank_account \
  -d "payment_method_data[us_bank_account][token]"={{stripe_bank_account_token}} \
  -d "payment_method_data[billing_details][name]"={{CUSTOMER_NAME}} \
  -d metadata[user_id]={{CUSTOMER_ID.metadata.user_id}}
```

--------------------------------

### stripe agent setup

Source: https://docs.stripe.com/cli/projects

Configures AI coding agent integrations for Stripe. Detects common agent harnesses and installs relevant Stripe plugins, skills, and MCP servers.

```APIDOC
## stripe agent setup

### Description
Set up tooling to help AI coding agents use Stripe. Supports Claude Code, Codex, and Cursor.

### Command
`stripe agent setup [flags]`

### Flags
- `--client <client>` (string) - Limit setup to a specific client. Supports `claude-code`, `codex`, and `cursor`.
- `--force` (boolean) - Reinstall agent tooling even if it's already installed.
- `--json` (boolean) - Print machine-readable status and planned actions without making changes.
- `--skills` (boolean) - Install Stripe skills directly, without an interactive prompt.
- `--skills-scope <scope>` (string) - Select where to install Stripe skills. Use `local` for current directory or `global` for home directory. Default is `local`.
- `--status` (boolean) - See currently installed agent tooling.
- `-y, --yes` (boolean) - Skip interactive prompts and set up all detected clients.

### Example
```bash
stripe agent setup
```
```

--------------------------------

### GET /v1/billing/meters/:id/event_summaries

Source: https://docs.stripe.com/api/billing/meter-event-summary/list

Lists billing meter event summaries for a specified meter. Summaries provide aggregated usage values within given start and end time boundaries.

```APIDOC
## GET /v1/billing/meters/:id/event_summaries

### Description
List billing meter event summaries for a meter. Meter events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.

### Method
GET

### Endpoint
/v1/billing/meters/:id/event_summaries

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the meter.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the object.
- **object** (string) - String representing the object's type, value is `billing.meter_event_summary`.
- **aggregated_value** (number) - Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
- **end_time** (timestamp) - End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
- **livemode** (boolean) - If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
- **meter** (string) - The meter associated with this event summary.
- **start_time** (timestamp) - Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.

#### Response Example
```json
{
  "id": "mtrusg_test_6041CMAXJrFdZ56U76ce6L35Hz7xA3Tn58z5sY7bq6gM3XN5bx5Y459D4Xt2E17ko6M86kt7kV3bl5PM7LV59l4sY50b6oU5QD7bY3HP58z5sY7bq6gM3Y57LF2Dr7od3Hb8927gh4Tt4Lo4xO4ge60T81C6Y53gl4QS2D33ft3HC3Xi3Cy3Cy3Cy",
  "object": "billing.meter_event_summary",
  "aggregated_value": 10,
  "end_time": 1711659600,
  "livemode": false,
  "meter": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA",
  "start_time": 1711656000
}
```
```

--------------------------------

### Run onboarding synchronization job

Source: https://docs.stripe.com/use-stripe-apps/mirakl/reference

Fetches newly created Mirakl shops and adds the onboarding link to their Mirakl back office. Default setting is every minute; recommended setting is as often as possible.

```bash

php bin/console connector:sync:onboarding -q 2>&1

```

--------------------------------

### Trigger a webhook event with stripe trigger

Source: https://docs.stripe.com/cli/additional_commands

Triggers an example webhook event against the Stripe API for local testing. All necessary related API objects are created as side effects during fixture setup.

```shell
stripe trigger invoice.payment_succeeded

Setting up fixture for: customer
Setting up fixture for: invoiceitem
Setting up fixture for: invoice
Setting up fixture for: invoice_pay
Trigger succeeded! Check dashboard for event details.
```

--------------------------------

### POST /v2/money_management/outbound_setup_intents

Source: https://docs.stripe.com/keys/permissions-reference

Create an outbound setup intent. Requires the `v2_account_merchant_write` permission.

```APIDOC
## POST /v2/money_management/outbound_setup_intents

### Description
Allows creating an outbound setup intent.

### Method
POST

### Endpoint
`/v2/money_management/outbound_setup_intents`

### Required Permission
`v2_account_merchant_write`
```

--------------------------------

### List ForwardingRequests with cURL

Source: https://docs.stripe.com/api/forwarding/forwarding_requests/retrieve

Send a GET request to /v1/forwarding/requests to list ForwardingRequest objects with optional query parameters such as limit. The example demonstrates retrieving a list limited to 3 items alongside the corresponding JSON response.

```curl

curl -G https://api.stripe.com/v1/forwarding/requests \
  -u "sk_test_...sk_test_...:" \
  -d limit=3

```

```json

{
  "object": "list",
  "url": "/v1/forwarding/requests",
  "has_more": false,
  "data": [
    {
      "id": "fwdreq_123",
      "object": "forwarding.request",
      "created": 1234567890,
      "livemode": false,
      "payment_method": "pm_456",
      "request_details": {
        "body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"paymentMethod\":{\"number\":\"424242******4242\",\"expiryMonth\":\"03\",\"expiryYear\":\"2030\",\"cvc\":\"***\",\"holderName\":\"First Last\"},\"reference\":\"{{REFERENCE_ID}}\"}",
        "headers": [
          {
            "name": "Destination-API-Key",
            "value": "{{DESTINATION_API_KEY}}"
          },
          {
            "name": "Destination-Idempotency-Key",
            "value": "{{DESTINATION_IDEMPOTENCY_KEY}}"
          },
          {
            "name": "Content-Type",
            "value": "application/json"
          }
        ],
        "http_method": "POST"
      },
      "request_context": {
        "destination_ip_address": "35.190.113.80",
        "destination_duration": 234
      },
      "response_details": {
        "body": "{\"transactionId\":\"example1234\"}",
        "headers": [
          {
            "name": "Content-Type",
            "value": "application/json;charset=UTF-8"
          }
        ],
        "status": 200
      },
      "url": "https://endpoint-url/v1/payments",
      "replacements": [
        "card_number",
        "card_expiry",
        "card_cvc",
        "cardholder_name"
      ]
    }
  ]
}

```

--------------------------------

### Configure fullpage post_install_action

Source: https://docs.stripe.com/stripe-apps/post-install-actions

Launch the app's full-page view immediately after installation. Requires defining a stripe.dashboard.fullpage viewport.

```json
{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "permissions": [],
  "app_backend": {},
  "ui_extension": {},
  "post_install_action": {
    "type": "fullpage"
  }
}
```

--------------------------------

### List SetupIntents for a Customer

Source: https://docs.stripe.com/payments/acss-debit/set-up-payment

Use this command to retrieve SetupIntents associated with a specific customer ID to obtain the saved PaymentMethod and Mandate IDs.

```bash
curl -G https://api.stripe.com/v1/setup_intents \
  -u "sk_test_...:" \
  -d "customer=
{{CUSTOMER_ID}}
"
```

--------------------------------

### Set up AI coding clients interactively using stripe agent setup

Source: https://docs.stripe.com/cli/additional_commands

Detects common AI coding agent harnesses such as Claude Code, Codex, and Cursor, and installs the relevant Stripe plugin, skills, and MCP server.

```shell
stripe agent setup
```

--------------------------------

### GET /v1/setup_attempts

Source: https://docs.stripe.com/api/setup_attempts/list

Lists all SetupAttempt objects. You can use SetupAttempts to inspect details of specific attempts at setting up a payment method using a SetupIntent.

```APIDOC
## GET /v1/setup_attempts

### Description
Returns a list of SetupAttempts. A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful.

### Method
GET

### Endpoint
/v1/setup_attempts

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the object.
- **object** (string) - String representing the object's type, value is `setup_attempt`.
- **application** (nullable string) - The value of application on the SetupIntent at the time of this confirmation.
- **attach_to_self** (nullable boolean) - If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
- **created** (timestamp) - Time at which the object was created. Measured in seconds since the Unix epoch.
- **customer** (nullable string) - The value of customer on the SetupIntent at the time of this confirmation.
- **customer_account** (nullable string) - The value of customer_account on the SetupIntent at the time of this confirmation.
- **flow_directions** (nullable array of enums) - Indicates the directions of money movement for which this payment method is intended to be used (`inbound`, `outbound`).
- **livemode** (boolean) - If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
- **on_behalf_of** (nullable string) - The value of on_behalf_of on the SetupIntent at the time of this confirmation.
- **payment_method** (string) - ID of the payment method used with this SetupAttempt.
- **payment_method_details** (object) - Details about the payment method at the time of SetupIntent confirmation.
- **setup_error** (nullable object) - The error encountered during this attempt to confirm the SetupIntent, if any.
- **setup_intent** (string) - ID of the SetupIntent that this attempt belongs to.
- **status** (string) - Status of this SetupAttempt (`requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`).
- **usage** (string) - The value of usage on the SetupIntent at the time of this confirmation (`off_session` or `on_session`).

#### Response Example
```json
{
  "id": "setatt_1ErTsH2eZvKYlo2CI7ukcoF7",
  "object": "setup_attempt",
  "application": null,
  "created": 1562004309,
  "customer": null,
  "flow_directions": null,
  "livemode": false,
  "on_behalf_of": null,
  "payment_method": "pm_1ErTsG2eZvKYlo2CH0DNen59",
  "payment_method_details": {
    "card": {
      "three_d_secure": null
    },
    "type": "card"
  },
  "setup_error": null,
  "setup_intent": "seti_1ErTsG2eZvKYlo2CKaT8MITz",
  "status": "succeeded",
  "usage": "off_session"
}
```
```

--------------------------------

### Install Stripe CLI with Homebrew

Source: https://docs.stripe.com/stripe-apps/back-end-app-example

Installs the Stripe CLI using Homebrew. Ensure Homebrew is installed on your system before running this command.

```shell

# Install Homebrew to run this command: https://brew.sh/
brew install stripe/stripe-cli/stripe

```

--------------------------------

### Set up the module using Magento CLI

Source: https://docs.stripe.com/use-stripe-apps/adobe-commerce/payments/install

Run these Magento CLI commands to upgrade the schema and flush/clean the cache after installing the module.

```bash

php bin/magento setup:upgrade
php bin/magento cache:flush
php bin/magento cache:clean

```

--------------------------------

### Align elements to start in horizontal stack

Source: https://docs.stripe.com/stripe-apps/style

Aligns horizontal stack elements to the start using alignX: 'start' with medium gap spacing.

```jsx

<Box
  css={{
    stack: 'x',
    gap: 'medium',
    alignX: 'start',
  }}
>

```

--------------------------------

### GET /v1/terminal/hardware_orders/preview

Source: https://docs.stripe.com/api/terminal/hardware_orders/preview

Get a preview of a TerminalHardwareOrder without creating it.

```APIDOC
## GET /v1/terminal/hardware_orders/preview

### Description
Get a preview of a TerminalHardwareOrder without creating it.

### Method
GET

### Endpoint
`/v1/terminal/hardware_orders/preview`

### Parameters
#### Query Parameters
- **hardware_order_items** (array of objects) - Required - An array of line items to order.
- **payment_type** (enum) - Required - The method of payment for this order.
- **shipping** (object) - Required - Shipping address for the order.
- **shipping_method** (string) - Required - The Shipping Method for the order.
- **metadata** (map) - Optional - 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
- **po_number** (string) - Optional - Purchase order number.

### Response
#### Success Response (200)
Returns a `TerminalHardwareOrder` object (that has not been created) if the preview succeeds.

#### Response Example
```json
{
  "object": "terminal.hardware_order",
  "amount": 13602,
  "currency": "usd",
  "hardware_order_items": [
    {
      "amount": 11800,
      "currency": "usd",
      "quantity": 2,
      "terminal_hardware_sku": {
        "id": "thsku_OEu70OWVaQ0DG3",
        "amount": 450,
        "country": "US",
        "currency": "usd",
        "product": "thpr_NGubNsbUoS1oik"
      }
    }
  ],
  "livemode": true,
  "metadata": {},
  "payment_type": "monthly_invoice",
  "po_number": null,
  "shipment_tracking": [],
  "shipping": {
    "address": {
      "city": "San Francisco",
      "country": "US",
      "line1": "1234 Main Street",
      "line2": "",
      "postal_code": "94111",
      "state": "CA"
    },
    "amount": 800,
    "company": "Rocket Rides",
    "currency": "usd",
    "email": "test@example.com",
    "name": "Jenny Rosen",
    "phone": "15555555555"
  },
  "shipping_method": "thsm_MfuTjLaPEgXMa4",
  "status": "pending",
  "tax": 1002,
  "total_tax_amounts": [
    {
      "amount": 1002,
      "inclusive": false,
      "rate": {
        "display_name": "Sales Tax",
        "jurisdiction": "LOS ANGELES",
        "percentage": 8.25
      }
    }
  ]
}
```
```

--------------------------------

### Run the application with ruby server.rb

Source: https://docs.stripe.com/payments/quickstart-checkout-sessions

Start the Ruby server before navigating to the checkout page in the browser.

```bash
ruby server.rb
```

--------------------------------

### Handle install state lifecycle events with HTML and JavaScript

Source: https://docs.stripe.com/connect/supported-embedded-components/app-install

Mounts the App install component into an HTML container and attaches handlers for fetched and changed install states.

```html

<div id="app-install-container"></div>

```

```javascript

// Do something when install state fetched on render
const handleAppInstallFetched = (response) => {
  console.log(`Install state fetched for app  ${response.appId} to ${response.state}`);
};

// Do something when install state changes
const handleAppInstallChanged = (response) => {
  console.log(`Install state changed for app  ${response.appId} to ${response.state}`);
};


const container = document.getElementById('app-install-container');
const appInstall = stripeConnectInstance.create('app-install');
appInstall.setApp('{{APP_ID}}');
appInstall.setOnAppInstallStateFetched(handleAppInstallFetched);
appInstall.setOnAppInstallStateChanged(handleAppInstallChanged);
container.appendChild(appInstall);

```
Tokens:
Raw