# Increment an authorization

Perform an incremental authorization on an eligible [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object.md). To be eligible, the PaymentIntent’s status must be `requires_capture` and [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object.md#charge_object-payment_method_details-card_present-incremental_authorization_supported) must be `true`.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher `amount` provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated [amount](https://docs.stripe.com/docs/api/payment_intents/object.md#payment_intent_object-amount). If the incremental authorization fails, a [card_declined](https://docs.stripe.com/docs/error-codes.md#card-declined) error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations.md).

## Returns

Returns a PaymentIntent object with the updated amount if the incremental authorization succeeds. Returns an error if the incremental authorization failed or the PaymentIntent isn’t eligible for incremental authorizations.

## Parameters

- `amount` (integer, required)
  The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.

- `amount_details` (object, optional)
  Provides industry-specific information about the amount.

  - `amount_details.discount_amount` (integer, optional)
    The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/docs/currencies.md#zero-decimal). An integer greater than 0.

    This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.

  - `amount_details.enforce_arithmetic_validation` (boolean, optional)
    Set to `false` to return arithmetic validation errors in the response without failing the request. Use this when you want the operation to proceed regardless of arithmetic errors in the line item data.

    Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies.

    For card payments, Stripe doesn’t send line item data to card networks if there’s an arithmetic validation error.

  - `amount_details.line_items` (array of objects, optional)
    A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.

    - `amount_details.line_items.product_name` (string, required)
      The product name of the line item. Required for L3 rates. At most 1024 characters long.

      For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters.

    - `amount_details.line_items.quantity` (integer, required)
      The quantity of items. Required for L3 rates. An integer greater than 0.

    - `amount_details.line_items.unit_cost` (integer, required)
      The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/docs/currencies.md#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.

    - `amount_details.line_items.discount_amount` (integer, optional)
      The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/docs/currencies.md#zero-decimal). An integer greater than 0.

      This field is mutually exclusive with the `amount_details[discount_amount]` field.

    - `amount_details.line_items.payment_method_options` (object, optional)
      Payment method-specific information for line items.

      - `amount_details.line_items.payment_method_options.card` (object, optional)
        This sub-hash contains line item details that are specific to the `card` payment method.

        - `amount_details.line_items.payment_method_options.card.commodity_code` (string, optional)
          Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on.

          The maximum length is 12 characters.

      - `amount_details.line_items.payment_method_options.card_present` (object, optional)
        This sub-hash contains line item details that are specific to the `card_present` payment method.

        - `amount_details.line_items.payment_method_options.card_present.commodity_code` (string, optional)
          Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on.

          The maximum length is 12 characters.

      - `amount_details.line_items.payment_method_options.klarna` (object, optional)
        This sub-hash contains line item details that are specific to the `klarna` payment method.

        - `amount_details.line_items.payment_method_options.klarna.image_url` (string, optional)
          URL to an image for the product. Max length, 4096 characters.

        - `amount_details.line_items.payment_method_options.klarna.product_url` (string, optional)
          URL to the product page. Max length, 4096 characters.

        - `amount_details.line_items.payment_method_options.klarna.reference` (string, optional)
          Unique reference for this line item to correlate it with your system’s internal records. The field is displayed in the Klarna Consumer App if passed.

          The maximum length is 255 characters.

        - `amount_details.line_items.payment_method_options.klarna.subscription_reference` (string, optional)
          Reference for the subscription this line item is for.

          The maximum length is 255 characters.

      - `amount_details.line_items.payment_method_options.paypal` (object, optional)
        This sub-hash contains line item details that are specific to the `paypal` payment method.

        - `amount_details.line_items.payment_method_options.paypal.category` (enum, optional)
          Type of the line item.
Possible enum values:
          - `digital_goods`
            Goods that are stored, delivered, and used in their electronic format.

          - `donation`
            A contribution or gift for which no good or service is exchanged, usually to a not for profit organization.

          - `physical_goods`
            A tangible item that can be shipped with proof of delivery.

        - `amount_details.line_items.payment_method_options.paypal.description` (string, optional)
          Description of the line item.

          The maximum length is 127 characters.

        - `amount_details.line_items.payment_method_options.paypal.sold_by` (string, optional)
          The Stripe account ID of the connected account that sells the item.

          The maximum length is 127 characters.

    - `amount_details.line_items.product_code` (string, optional)
      The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.

      The maximum length is 12 characters.

    - `amount_details.line_items.tax` (object, optional)
      Contains information about the tax on the item.

      - `amount_details.line_items.tax.total_tax_amount` (integer, required)
        The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/docs/currencies.md#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.

        This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field.

    - `amount_details.line_items.unit_of_measure` (string, optional)
      A unit of measure for the line item, such as gallons, feet, meters, etc.

      The maximum length is 12 characters.

  - `amount_details.shipping` (object, optional)
    Contains information about the shipping portion of the amount.

    - `amount_details.shipping.amount` (integer, optional)
      If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/docs/currencies.md#zero-decimal). An integer greater than or equal to 0.

    - `amount_details.shipping.from_postal_code` (string, optional)
      If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed.

      The maximum length is 10 characters.

    - `amount_details.shipping.to_postal_code` (string, optional)
      If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed.

      The maximum length is 10 characters.

  - `amount_details.tax` (object, optional)
    Contains information about the tax portion of the amount.

    - `amount_details.tax.total_tax_amount` (integer, required)
      The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/docs/currencies.md#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.

      This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.

- `application_fee_amount` (integer, optional)
  The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/docs/payments/connected-accounts.md).

- `description` (string, optional)
  An arbitrary string attached to the object. Often useful for displaying to users.

- `hooks` (object, optional)
  Automations to be run during the PaymentIntent lifecycle

  - `hooks.inputs` (object, optional)
    Arguments passed in automations

    - `hooks.inputs.tax` (object, optional)
      Tax arguments for automations

      - `hooks.inputs.tax.calculation` (string, required)
        The [TaxCalculation](https://docs.stripe.com/docs/api/tax/calculations.md) id

- `metadata` (object, optional)
  Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata.md) 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`.

- `payment_details` (object, optional)
  Provides industry-specific information about the charge.

  - `payment_details.customer_reference` (string, optional)
    A unique value to identify the customer. This field is available only for card payments.

    This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.

  - `payment_details.order_reference` (string, optional)
    A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.

    For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.

- `statement_descriptor` (string, optional)
  Text that appears on the customer’s statement as the statement descriptor for a non-card or card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors.md).

- `transfer_data` (object, optional)
  The parameters used to automatically create a transfer after the payment is captured. Learn more about the [use case for connected accounts](https://docs.stripe.com/docs/payments/connected-accounts.md).

  - `transfer_data.amount` (integer, optional)
    The amount that will be transferred automatically when a charge succeeds.

```curl
curl https://api.stripe.com/v1/payment_intents/pi_1DtBRR2eZvKYlo2CmCVxxvd7/increment_authorization \
  -u "<<YOUR_SECRET_KEY>>" \
  -d amount=2099
```

### Response

```json
{
  "id": "pi_1DtBRR2eZvKYlo2CmCVxxvd7",
  "object": "payment_intent",
  "amount": 2099,
  "amount_capturable": 2099,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": null,
  "canceled_at": null,
  "cancellation_reason": null,
  "capture_method": "manual",
  "client_secret": "pi_1DtBRR2eZvKYlo2CmCVxxvd7_secret_cWsUkvyTOjhLKh5Wxu61nYc0i",
  "confirmation_method": "automatic",
  "created": 1680196960,
  "currency": "usd",
  "customer": null,
  "description": null,
  "last_payment_error": null,
  "latest_charge": "ch_3MrPBM2eZvKYlo2C1CEBUD4A",
  "livemode": false,
  "metadata": {},
  "next_action": null,
  "on_behalf_of": null,
  "payment_method": "pm_1MrPBL2eZvKYlo2CaNa8L11Z",
  "payment_method_options": {
    "card": {
      "installments": null,
      "mandate_options": null,
      "network": null,
      "request_three_d_secure": "automatic"
    }
  },
  "payment_method_types": [
    "card"
  ],
  "processing": null,
  "receipt_email": null,
  "redaction": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": null,
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_capture",
  "transfer_data": null,
  "transfer_group": null
}
```