Stripe: Retrieve an Invoice Payment

← Invoice payments operations · Get started

Operation stripe.getinvoicepaymentsinvoicepayment

Provider route: GET /v1/invoice_payments/{invoice_payment}. 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["invoicePayments"]["getInvoicePaymentsInvoicePayment"]>[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.invoicePayments.getInvoicePaymentsInvoicePayment(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.invoice_payments.get_invoice_payments_invoice_payment(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.invoice_payment	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 Retrieve an Invoice Payment — response body

Referenced models: Retrieve an Invoice Payment — response body

Schemas

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

Retrieve an Invoice Payment — response body

Field	Type	Presence	Description and constraints
$	object	Root	Invoice Payments represent payments made against invoices. Invoice Payments can be accessed in two ways: 1. By expanding the `payments` field on the [Invoice](https://docs.stripe.com/api#invoice) resource. 2. By using the Invoice Payment retrieve and list endpoints. Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and monitor the allocation details of the payments.
amount_paid	JSON	Optional
amount_paid (anyOf 1)	JSON	Alternative
amount_paid (anyOf 1) (anyOf 1)	integer	Alternative	Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.
amount_paid (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_paid (anyOf 2)	null	Alternative
amount_requested	JSON	Required within parent
amount_requested (anyOf 1)	integer	Alternative	Amount intended to be paid toward this invoice, in cents (or local equivalent)
amount_requested (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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]+)?$
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Maximum length: 5000
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
invoice	JSON	Required within parent	The invoice that was paid.
invoice (anyOf 1)	string	Alternative	Maximum length: 5000
invoice (anyOf 2)	Model	Alternative	Expand Pay an invoice — response body
invoice (anyOf 3)	Model	Alternative	Expand Delete a draft invoice — response body
is_default	boolean	Required within parent	Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly.
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`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: invoice_payment
payment	Model	Required within parent	Expand Retrieve an Invoice Payment — response body — payment
status	string	Required within parent	The status of the payment, one of `open`, `paid`, or `canceled`. Maximum length: 5000
status_transitions	Model	Required within parent	Expand Retrieve an Invoice Payment — response body — status transitions

Referenced models: Delete a draft invoice — response body, Pay an invoice — response body, Retrieve an Invoice Payment — response body — payment, Retrieve an Invoice Payment — response body — status transitions

Delete a draft invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. 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: invoice

Retrieve an Invoice Payment — response body — payment

Field	Type	Presence	Description and constraints
$	object	Root
charge	JSON	Optional	ID of the successful charge for this payment when `type` is `charge`. Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
charge (anyOf 1)	string	Alternative	Maximum length: 5000
charge (anyOf 2)	Model	Alternative	Expand Create a charge — response body
payment_intent	JSON	Optional	ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body
payment_record	JSON	Optional	ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
payment_record (anyOf 1)	string	Alternative	Maximum length: 5000
payment_record (anyOf 2)	Model	Alternative	Expand Report a refund — response body
type	string	Required within parent	Type of payment object associated with this invoice payment. Known values: charge, payment_intent, payment_record

Referenced models: Create a charge — response body, Cancel a Payment Intent — response body, Report a refund — response body

Retrieve an Invoice Payment — response body — status transitions

Field	Type	Presence	Description and constraints
$	object	Root
canceled_at	JSON	Optional
canceled_at (anyOf 1)	JSON	Alternative
canceled_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the payment was canceled. Format: unix-time
canceled_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canceled_at (anyOf 2)	null	Alternative
paid_at	JSON	Optional
paid_at (anyOf 1)	JSON	Alternative
paid_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the payment succeeded. Format: unix-time
paid_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
paid_at (anyOf 2)	null	Alternative

Create a Location — response body — address

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	City, district, suburb, town, or village. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
country (anyOf 2)	null	Alternative
line1	JSON	Optional
line1 (anyOf 1)	string	Alternative	Address line 1, such as the street, PO Box, or company name. Maximum length: 5000
line1 (anyOf 2)	null	Alternative
line2	JSON	Optional
line2 (anyOf 1)	string	Alternative	Address line 2, such as the apartment, suite, unit, or building. Maximum length: 5000
line2 (anyOf 2)	null	Alternative
postal_code	JSON	Optional
postal_code (anyOf 1)	string	Alternative	ZIP or postal code. Maximum length: 5000
postal_code (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000
state (anyOf 2)	null	Alternative

PostApplicationFeesIdRefund — response body — application / object: application

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the application. 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: application

Delete a customer — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. 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: customer

Policy, approvals and errors

SDK function policy ID: stripe.getinvoicepaymentsinvoicepayment. Catalog operation: GetInvoicePaymentsInvoicePayment. 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