Stripe: Preview a credit note

← Credit notes operations · Get started

Operation stripe.getcreditnotespreview

Provider route: GET /v1/credit_notes/preview. 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["creditNotes"]["getCreditNotesPreview"]>[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.creditNotes.getCreditNotesPreview(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.credit_notes.get_credit_notes_preview(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.amount	integer	Optional
query.credit_amount	integer	Optional
query.effective_at	integer	Optional	Format: unix-time
query.email_type	string	Optional	One of: credit_note, none
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.invoice	string	Required within parent	Maximum length: 5000
query.lines	array	Optional
query.lines[]	Model	Each item	Expand Create a credit note — request body — body lines item
query.memo	string	Optional	Maximum length: 5000
query.metadata	object	Optional	Additional keys: see wildcard field
query.metadata.*	string	Additional keys
query.out_of_band_amount	integer	Optional
query.reason	string	Optional	One of: duplicate, fraudulent, order_change, product_unsatisfactory
query.refund_amount	integer	Optional
query.refunds	array	Optional
query.refunds[]	object	Each item
query.refunds[].amount_refunded	integer	Optional
query.refunds[].payment_record_refund	object	Optional
query.refunds[].payment_record_refund.payment_record	string	Required within parent	Maximum length: 5000
query.refunds[].payment_record_refund.refund_group	string	Required within parent	Maximum length: 5000
query.refunds[].refund	string	Optional
query.refunds[].type	string	Optional	One of: payment_record_refund, refund
query.shipping_cost	object	Optional
query.shipping_cost.shipping_rate	string	Optional	Maximum length: 5000

Referenced models: Create a credit note — request body — body lines item

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 Void a credit note — response body

Referenced models: Void a credit note — response body

Schemas

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

Create a credit note — request body — body lines item

Field	Type	Presence	Description and constraints
$	object	Root
amount	integer	Optional
description	string	Optional	Maximum length: 5000
invoice_line_item	string	Optional	Maximum length: 5000
metadata	object	Optional	Additional keys: see wildcard field
metadata.*	string	Additional keys
quantity	integer	Optional
tax_amounts	JSON	Optional
tax_amounts (anyOf 1)	array	Alternative
tax_amounts (anyOf 1)[]	object	Each item
tax_amounts (anyOf 1)[].amount	integer	Required within parent
tax_amounts (anyOf 1)[].tax_rate	string	Required within parent	Maximum length: 5000
tax_amounts (anyOf 1)[].taxable_amount	integer	Required within parent
tax_amounts (anyOf 2)	string	Alternative	One of:
tax_rates	JSON	Optional
tax_rates (anyOf 1)	array	Alternative
tax_rates (anyOf 1)[]	string	Each item	Maximum length: 5000
tax_rates (anyOf 2)	string	Alternative	One of:
type	string	Required within parent	One of: custom_line_item, invoice_line_item
unit_amount	integer	Optional
unit_amount_decimal	string	Optional	Format: decimal

Update an invoice's line item — response body — taxes The tax information of the line item item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount of the tax, in cents (or local equivalent).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_behavior	string	Required within parent	Whether this tax is inclusive or exclusive. Known values: exclusive, inclusive
tax_rate_details	JSON	Optional
tax_rate_details (anyOf 1)	JSON	Alternative	Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
tax_rate_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — taxes The tax information of the line item item tax rate details value tax rate
tax_rate_details (anyOf 2)	null	Alternative
taxability_reason	string	Required within parent	The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Known values: customer_exempt, not_available, not_collecting, not_subject_to_tax, not_supported, portion_product_exempt, portion_reduced_rated, portion_standard_rated, product_exempt, product_exempt_holiday, proportionally_rated, reduced_rated, reverse_charge, standard_rated, taxable_basis_reduced, zero_rated
taxable_amount	JSON	Optional
taxable_amount (anyOf 1)	JSON	Alternative
taxable_amount (anyOf 1) (anyOf 1)	integer	Alternative	The amount on which tax is calculated, in cents (or local equivalent).
taxable_amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taxable_amount (anyOf 2)	null	Alternative
type	string	Required within parent	The type of tax information. Known values: tax_rate_details

Referenced models: Update an invoice's line item — response body — taxes The tax information of the line item item tax rate details value tax rate

Retrieve a credit note's line items — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	The credit note line item object
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	JSON	Optional
description (anyOf 1)	string	Alternative	Description of the item being credited. Maximum length: 5000
description (anyOf 2)	null	Alternative
discount_amount	JSON	Required within parent
discount_amount (anyOf 1)	integer	Alternative	The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
discount_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
discount_amounts	array	Required within parent	The amount of discount calculated per discount for this line item
discount_amounts[]	Model	Each item	Expand Void a credit note — response body — discount amounts item
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
invoice_line_item	string	Optional	ID of the invoice line item being credited 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`.
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	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 (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (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: credit_note_line_item
pretax_credit_amounts	array	Required within parent	The pretax credit amounts (ex: discount, credit grants, etc) for this line item.
pretax_credit_amounts[]	Model	Each item	Expand Void a credit note — response body — pretax credit amounts item
quantity	JSON	Optional
quantity (anyOf 1)	JSON	Alternative
quantity (anyOf 1) (anyOf 1)	integer	Alternative	The number of units of product being credited.
quantity (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)	null	Alternative
tax_rates	array	Required within parent	The tax rates which apply to the line item.
tax_rates[]	Model	Each item	Expand Create a tax rate — response body
taxes	JSON	Optional
taxes (anyOf 1)	array	Alternative	The tax information of the line item.
taxes (anyOf 1)[]	Model	Each item	Expand Update an invoice's line item — response body — taxes The tax information of the line item item
taxes (anyOf 2)	null	Alternative
type	string	Required within parent	The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice. Known values: custom_line_item, invoice_line_item
unit_amount	JSON	Optional
unit_amount (anyOf 1)	JSON	Alternative
unit_amount (anyOf 1) (anyOf 1)	integer	Alternative	The cost of each unit of product being credited.
unit_amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_amount (anyOf 2)	null	Alternative
unit_amount_decimal	JSON	Optional
unit_amount_decimal (anyOf 1)	string	Alternative	Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. Format: decimal
unit_amount_decimal (anyOf 2)	null	Alternative

Referenced models: Update an invoice's line item — response body — taxes The tax information of the line item item, Void a credit note — response body — pretax credit amounts item, Void a credit note — response body — discount amounts item, Create a tax rate — response body

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

Update an invoice's line item — response body — taxes The tax information of the line item item tax rate details value tax rate

Field	Type	Presence	Description and constraints
$	object	Root
tax_rate	JSON	Required within parent	ID of the tax rate
tax_rate (anyOf 1)	string	Alternative	Maximum length: 5000
tax_rate (anyOf 2)	Model	Alternative	Expand Create a tax rate — response body

Referenced models: Create a tax rate — response body

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

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