Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. CreditNote
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.CreditNote

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    Issue a credit note to adjust an invoice’s amount after the invoice is finalized.

    Related guide: Credit notes

    Create CreditNote Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CreditNote(name: string, args: CreditNoteArgs, opts?: CustomResourceOptions);
    @overload
def CreditNote(resource_name: str,
               args: CreditNoteArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def CreditNote(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               invoice: Optional[str] = None,
               amount: Optional[float] = None,
               credit_amount: Optional[float] = None,
               effective_at: Optional[float] = None,
               email_type: Optional[str] = None,
               memo: Optional[str] = None,
               metadata: Optional[Mapping[str, str]] = None,
               out_of_band_amount: Optional[float] = None,
               reason: Optional[str] = None,
               refund_amount: Optional[float] = None,
               refunds: Optional[Sequence[CreditNoteRefundArgs]] = None,
               shipping_cost: Optional[CreditNoteShippingCostArgs] = None)
    func NewCreditNote(ctx *Context, name string, args CreditNoteArgs, opts ...ResourceOption) (*CreditNote, error)
    public CreditNote(string name, CreditNoteArgs args, CustomResourceOptions? opts = null)
    public CreditNote(String name, CreditNoteArgs args)
public CreditNote(String name, CreditNoteArgs args, CustomResourceOptions options)

    type: stripe:CreditNote
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_credit_note" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CreditNoteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CreditNoteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CreditNoteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CreditNoteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CreditNoteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var creditNoteResource = new Stripe.CreditNote("creditNoteResource", new()
{
    Invoice = "string",
    Amount = 0.0,
    CreditAmount = 0.0,
    EffectiveAt = 0.0,
    EmailType = "string",
    Memo = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    OutOfBandAmount = 0.0,
    Reason = "string",
    RefundAmount = 0.0,
    Refunds = new[]
    {
        new Stripe.Inputs.CreditNoteRefundArgs
        {
            AmountRefunded = 0.0,
            PaymentRecordRefund = new Stripe.Inputs.CreditNoteRefundPaymentRecordRefundArgs
            {
                PaymentRecord = "string",
                RefundGroup = "string",
            },
            Refund = "string",
            Type = "string",
        },
    },
    ShippingCost = new Stripe.Inputs.CreditNoteShippingCostArgs
    {
        AmountSubtotal = 0.0,
        AmountTax = 0.0,
        AmountTotal = 0.0,
        ShippingRate = "string",
        Taxes = new[]
        {
            new Stripe.Inputs.CreditNoteShippingCostTaxArgs
            {
                Amount = 0.0,
                Rate = "string",
                TaxabilityReason = "string",
                TaxableAmount = 0.0,
            },
        },
    },
});

    example, err := stripe.NewCreditNote(ctx, "creditNoteResource", &stripe.CreditNoteArgs{
	Invoice:      pulumi.String("string"),
	Amount:       pulumi.Float64(0),
	CreditAmount: pulumi.Float64(0),
	EffectiveAt:  pulumi.Float64(0),
	EmailType:    pulumi.String("string"),
	Memo:         pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	OutOfBandAmount: pulumi.Float64(0),
	Reason:          pulumi.String("string"),
	RefundAmount:    pulumi.Float64(0),
	Refunds: stripe.CreditNoteRefundArray{
		&stripe.CreditNoteRefundArgs{
			AmountRefunded: pulumi.Float64(0),
			PaymentRecordRefund: &stripe.CreditNoteRefundPaymentRecordRefundArgs{
				PaymentRecord: pulumi.String("string"),
				RefundGroup:   pulumi.String("string"),
			},
			Refund: pulumi.String("string"),
			Type:   pulumi.String("string"),
		},
	},
	ShippingCost: &stripe.CreditNoteShippingCostArgs{
		AmountSubtotal: pulumi.Float64(0),
		AmountTax:      pulumi.Float64(0),
		AmountTotal:    pulumi.Float64(0),
		ShippingRate:   pulumi.String("string"),
		Taxes: stripe.CreditNoteShippingCostTaxArray{
			&stripe.CreditNoteShippingCostTaxArgs{
				Amount:           pulumi.Float64(0),
				Rate:             pulumi.String("string"),
				TaxabilityReason: pulumi.String("string"),
				TaxableAmount:    pulumi.Float64(0),
			},
		},
	},
})

    resource "stripe_credit_note" "creditNoteResource" {
  lifecycle {
    create_before_destroy = true
  }
  invoice       = "string"
  amount        = 0
  credit_amount = 0
  effective_at  = 0
  email_type    = "string"
  memo          = "string"
  metadata = {
    "string" = "string"
  }
  out_of_band_amount = 0
  reason             = "string"
  refund_amount      = 0
  refunds {
    amount_refunded = 0
    payment_record_refund = {
      payment_record = "string"
      refund_group   = "string"
    }
    refund = "string"
    type   = "string"
  }
  shipping_cost = {
    amount_subtotal = 0
    amount_tax      = 0
    amount_total    = 0
    shipping_rate   = "string"
    taxes = [{
      amount            = 0
      rate              = "string"
      taxability_reason = "string"
      taxable_amount    = 0
    }]
  }
}

    var creditNoteResource = new CreditNote("creditNoteResource", CreditNoteArgs.builder()
    .invoice("string")
    .amount(0.0)
    .creditAmount(0.0)
    .effectiveAt(0.0)
    .emailType("string")
    .memo("string")
    .metadata(Map.of("string", "string"))
    .outOfBandAmount(0.0)
    .reason("string")
    .refundAmount(0.0)
    .refunds(CreditNoteRefundArgs.builder()
        .amountRefunded(0.0)
        .paymentRecordRefund(CreditNoteRefundPaymentRecordRefundArgs.builder()
            .paymentRecord("string")
            .refundGroup("string")
            .build())
        .refund("string")
        .type("string")
        .build())
    .shippingCost(CreditNoteShippingCostArgs.builder()
        .amountSubtotal(0.0)
        .amountTax(0.0)
        .amountTotal(0.0)
        .shippingRate("string")
        .taxes(CreditNoteShippingCostTaxArgs.builder()
            .amount(0.0)
            .rate("string")
            .taxabilityReason("string")
            .taxableAmount(0.0)
            .build())
        .build())
    .build());

    credit_note_resource = stripe.CreditNote("creditNoteResource",
    invoice="string",
    amount=float(0),
    credit_amount=float(0),
    effective_at=float(0),
    email_type="string",
    memo="string",
    metadata={
        "string": "string",
    },
    out_of_band_amount=float(0),
    reason="string",
    refund_amount=float(0),
    refunds=[{
        "amount_refunded": float(0),
        "payment_record_refund": {
            "payment_record": "string",
            "refund_group": "string",
        },
        "refund": "string",
        "type": "string",
    }],
    shipping_cost={
        "amount_subtotal": float(0),
        "amount_tax": float(0),
        "amount_total": float(0),
        "shipping_rate": "string",
        "taxes": [{
            "amount": float(0),
            "rate": "string",
            "taxability_reason": "string",
            "taxable_amount": float(0),
        }],
    })

    const creditNoteResource = new stripe.CreditNote("creditNoteResource", {
    invoice: "string",
    amount: 0,
    creditAmount: 0,
    effectiveAt: 0,
    emailType: "string",
    memo: "string",
    metadata: {
        string: "string",
    },
    outOfBandAmount: 0,
    reason: "string",
    refundAmount: 0,
    refunds: [{
        amountRefunded: 0,
        paymentRecordRefund: {
            paymentRecord: "string",
            refundGroup: "string",
        },
        refund: "string",
        type: "string",
    }],
    shippingCost: {
        amountSubtotal: 0,
        amountTax: 0,
        amountTotal: 0,
        shippingRate: "string",
        taxes: [{
            amount: 0,
            rate: "string",
            taxabilityReason: "string",
            taxableAmount: 0,
        }],
    },
});

    type: stripe:CreditNote
properties:
    amount: 0
    creditAmount: 0
    effectiveAt: 0
    emailType: string
    invoice: string
    memo: string
    metadata:
        string: string
    outOfBandAmount: 0
    reason: string
    refundAmount: 0
    refunds:
        - amountRefunded: 0
          paymentRecordRefund:
            paymentRecord: string
            refundGroup: string
          refund: string
          type: string
    shippingCost:
        amountSubtotal: 0
        amountTax: 0
        amountTotal: 0
        shippingRate: string
        taxes:
            - amount: 0
              rate: string
              taxabilityReason: string
              taxableAmount: 0

    CreditNote Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CreditNote resource accepts the following input properties:

    Invoice string
    ID of the invoice.
    Amount double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    CreditAmount double
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    EffectiveAt double
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    EmailType string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    Memo string
    Customer-facing text that appears on the credit note PDF.
    Metadata Dictionary<string, string>
    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.
    OutOfBandAmount double
    Amount that was credited outside of Stripe.
    Reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    RefundAmount double
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    Refunds List<CreditNoteRefund>
    Refunds related to this credit note.
    ShippingCost CreditNoteShippingCost
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    Invoice string
    ID of the invoice.
    Amount float64
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    CreditAmount float64
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    EffectiveAt float64
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    EmailType string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    Memo string
    Customer-facing text that appears on the credit note PDF.
    Metadata map[string]string
    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.
    OutOfBandAmount float64
    Amount that was credited outside of Stripe.
    Reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    RefundAmount float64
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    Refunds []CreditNoteRefundArgs
    Refunds related to this credit note.
    ShippingCost CreditNoteShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    invoice string
    ID of the invoice.
    amount number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    credit_amount number
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    effective_at number
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    email_type string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    memo string
    Customer-facing text that appears on the credit note PDF.
    metadata map(string)
    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.
    out_of_band_amount number
    Amount that was credited outside of Stripe.
    reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refund_amount number
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds list(object)
    Refunds related to this credit note.
    shipping_cost object
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    invoice String
    ID of the invoice.
    amount Double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    creditAmount Double
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    effectiveAt Double
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    emailType String
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    memo String
    Customer-facing text that appears on the credit note PDF.
    metadata Map<String,String>
    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.
    outOfBandAmount Double
    Amount that was credited outside of Stripe.
    reason String
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refundAmount Double
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds List<CreditNoteRefund>
    Refunds related to this credit note.
    shippingCost CreditNoteShippingCost
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    invoice string
    ID of the invoice.
    amount number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    creditAmount number
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    effectiveAt number
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    emailType string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    memo string
    Customer-facing text that appears on the credit note PDF.
    metadata {[key: string]: string}
    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.
    outOfBandAmount number
    Amount that was credited outside of Stripe.
    reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refundAmount number
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds CreditNoteRefund[]
    Refunds related to this credit note.
    shippingCost CreditNoteShippingCost
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    invoice str
    ID of the invoice.
    amount float
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    credit_amount float
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    effective_at float
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    email_type str
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    memo str
    Customer-facing text that appears on the credit note PDF.
    metadata Mapping[str, str]
    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.
    out_of_band_amount float
    Amount that was credited outside of Stripe.
    reason str
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refund_amount float
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds Sequence[CreditNoteRefundArgs]
    Refunds related to this credit note.
    shipping_cost CreditNoteShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    invoice String
    ID of the invoice.
    amount Number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    creditAmount Number
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    effectiveAt Number
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    emailType String
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    memo String
    Customer-facing text that appears on the credit note PDF.
    metadata Map<String>
    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.
    outOfBandAmount Number
    Amount that was credited outside of Stripe.
    reason String
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refundAmount Number
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds List<Property Map>
    Refunds related to this credit note.
    shippingCost Property Map
    The details of the cost of shipping, including the ShippingRate applied to the invoice.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CreditNote resource produces the following output properties:

    AmountShipping double
    This is the sum of all the shipping amounts.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer.
    CustomerBalanceTransaction string
    Customer balance transaction related to this credit note.
    DiscountAmount double
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    DiscountAmounts List<CreditNoteDiscountAmount>
    The aggregate amounts calculated per discount for all line items.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PostPaymentAmount double
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    PrePaymentAmount double
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    PretaxCreditAmounts List<CreditNotePretaxCreditAmount>
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    Status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    Subtotal double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    SubtotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    Total double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    TotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    TotalTaxes List<CreditNoteTotalTax>
    The aggregate tax information for all line items.
    Type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    VoidedAt double
    The time that the credit note was voided.
    AmountShipping float64
    This is the sum of all the shipping amounts.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer.
    CustomerBalanceTransaction string
    Customer balance transaction related to this credit note.
    DiscountAmount float64
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    DiscountAmounts []CreditNoteDiscountAmount
    The aggregate amounts calculated per discount for all line items.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PostPaymentAmount float64
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    PrePaymentAmount float64
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    PretaxCreditAmounts []CreditNotePretaxCreditAmount
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    Status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    Subtotal float64
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    SubtotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    Total float64
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    TotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    TotalTaxes []CreditNoteTotalTax
    The aggregate tax information for all line items.
    Type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    VoidedAt float64
    The time that the credit note was voided.
    amount_shipping number
    This is the sum of all the shipping amounts.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer.
    customer_balance_transaction string
    Customer balance transaction related to this credit note.
    discount_amount number
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discount_amounts list(object)
    The aggregate amounts calculated per discount for all line items.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object string
    String representing the object's type. Objects of the same type share the same value.
    post_payment_amount number
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    pre_payment_amount number
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretax_credit_amounts list(object)
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotal_excluding_tax number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    total_excluding_tax number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    total_taxes list(object)
    The aggregate tax information for all line items.
    type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voided_at number
    The time that the credit note was voided.
    amountShipping Double
    This is the sum of all the shipping amounts.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer.
    customerBalanceTransaction String
    Customer balance transaction related to this credit note.
    discountAmount Double
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discountAmounts List<CreditNoteDiscountAmount>
    The aggregate amounts calculated per discount for all line items.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    number String
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object String
    String representing the object's type. Objects of the same type share the same value.
    postPaymentAmount Double
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    prePaymentAmount Double
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretaxCreditAmounts List<CreditNotePretaxCreditAmount>
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    status String
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal Double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total Double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    totalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    totalTaxes List<CreditNoteTotalTax>
    The aggregate tax information for all line items.
    type String
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voidedAt Double
    The time that the credit note was voided.
    amountShipping number
    This is the sum of all the shipping amounts.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer.
    customerBalanceTransaction string
    Customer balance transaction related to this credit note.
    discountAmount number
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discountAmounts CreditNoteDiscountAmount[]
    The aggregate amounts calculated per discount for all line items.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object string
    String representing the object's type. Objects of the same type share the same value.
    postPaymentAmount number
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    prePaymentAmount number
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretaxCreditAmounts CreditNotePretaxCreditAmount[]
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotalExcludingTax number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    totalExcludingTax number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    totalTaxes CreditNoteTotalTax[]
    The aggregate tax information for all line items.
    type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voidedAt number
    The time that the credit note was voided.
    amount_shipping float
    This is the sum of all the shipping amounts.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    ID of the customer.
    customer_balance_transaction str
    Customer balance transaction related to this credit note.
    discount_amount float
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discount_amounts Sequence[CreditNoteDiscountAmount]
    The aggregate amounts calculated per discount for all line items.
    id str
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    number str
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object str
    String representing the object's type. Objects of the same type share the same value.
    post_payment_amount float
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    pre_payment_amount float
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretax_credit_amounts Sequence[CreditNotePretaxCreditAmount]
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    status str
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal float
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotal_excluding_tax float
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total float
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    total_excluding_tax float
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    total_taxes Sequence[CreditNoteTotalTax]
    The aggregate tax information for all line items.
    type str
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voided_at float
    The time that the credit note was voided.
    amountShipping Number
    This is the sum of all the shipping amounts.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer.
    customerBalanceTransaction String
    Customer balance transaction related to this credit note.
    discountAmount Number
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discountAmounts List<Property Map>
    The aggregate amounts calculated per discount for all line items.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    number String
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object String
    String representing the object's type. Objects of the same type share the same value.
    postPaymentAmount Number
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    prePaymentAmount Number
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretaxCreditAmounts List<Property Map>
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    status String
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal Number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total Number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    totalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    totalTaxes List<Property Map>
    The aggregate tax information for all line items.
    type String
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voidedAt Number
    The time that the credit note was voided.

    Look up Existing CreditNote Resource

    Get an existing CreditNote resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CreditNoteState, opts?: CustomResourceOptions): CreditNote
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount: Optional[float] = None,
        amount_shipping: Optional[float] = None,
        created: Optional[float] = None,
        credit_amount: Optional[float] = None,
        currency: Optional[str] = None,
        customer: Optional[str] = None,
        customer_balance_transaction: Optional[str] = None,
        discount_amount: Optional[float] = None,
        discount_amounts: Optional[Sequence[CreditNoteDiscountAmountArgs]] = None,
        effective_at: Optional[float] = None,
        email_type: Optional[str] = None,
        invoice: Optional[str] = None,
        livemode: Optional[bool] = None,
        memo: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        number: Optional[str] = None,
        object: Optional[str] = None,
        out_of_band_amount: Optional[float] = None,
        post_payment_amount: Optional[float] = None,
        pre_payment_amount: Optional[float] = None,
        pretax_credit_amounts: Optional[Sequence[CreditNotePretaxCreditAmountArgs]] = None,
        reason: Optional[str] = None,
        refund_amount: Optional[float] = None,
        refunds: Optional[Sequence[CreditNoteRefundArgs]] = None,
        shipping_cost: Optional[CreditNoteShippingCostArgs] = None,
        status: Optional[str] = None,
        subtotal: Optional[float] = None,
        subtotal_excluding_tax: Optional[float] = None,
        total: Optional[float] = None,
        total_excluding_tax: Optional[float] = None,
        total_taxes: Optional[Sequence[CreditNoteTotalTaxArgs]] = None,
        type: Optional[str] = None,
        voided_at: Optional[float] = None) -> CreditNote
    func GetCreditNote(ctx *Context, name string, id IDInput, state *CreditNoteState, opts ...ResourceOption) (*CreditNote, error)
    public static CreditNote Get(string name, Input<string> id, CreditNoteState? state, CustomResourceOptions? opts = null)
    public static CreditNote get(String name, Output<String> id, CreditNoteState state, CustomResourceOptions options)
    resources:  _:    type: stripe:CreditNote    get:      id: ${id}
    import {
  to = stripe_credit_note.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Amount double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    AmountShipping double
    This is the sum of all the shipping amounts.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CreditAmount double
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer.
    CustomerBalanceTransaction string
    Customer balance transaction related to this credit note.
    DiscountAmount double
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    DiscountAmounts List<CreditNoteDiscountAmount>
    The aggregate amounts calculated per discount for all line items.
    EffectiveAt double
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    EmailType string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    Invoice string
    ID of the invoice.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Memo string
    Customer-facing text that appears on the credit note PDF.
    Metadata Dictionary<string, string>
    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.
    Number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OutOfBandAmount double
    Amount that was credited outside of Stripe.
    PostPaymentAmount double
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    PrePaymentAmount double
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    PretaxCreditAmounts List<CreditNotePretaxCreditAmount>
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    Reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    RefundAmount double
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    Refunds List<CreditNoteRefund>
    Refunds related to this credit note.
    ShippingCost CreditNoteShippingCost
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    Status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    Subtotal double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    SubtotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    Total double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    TotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    TotalTaxes List<CreditNoteTotalTax>
    The aggregate tax information for all line items.
    Type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    VoidedAt double
    The time that the credit note was voided.
    Amount float64
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    AmountShipping float64
    This is the sum of all the shipping amounts.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CreditAmount float64
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    ID of the customer.
    CustomerBalanceTransaction string
    Customer balance transaction related to this credit note.
    DiscountAmount float64
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    DiscountAmounts []CreditNoteDiscountAmountArgs
    The aggregate amounts calculated per discount for all line items.
    EffectiveAt float64
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    EmailType string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    Invoice string
    ID of the invoice.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Memo string
    Customer-facing text that appears on the credit note PDF.
    Metadata map[string]string
    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.
    Number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OutOfBandAmount float64
    Amount that was credited outside of Stripe.
    PostPaymentAmount float64
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    PrePaymentAmount float64
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    PretaxCreditAmounts []CreditNotePretaxCreditAmountArgs
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    Reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    RefundAmount float64
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    Refunds []CreditNoteRefundArgs
    Refunds related to this credit note.
    ShippingCost CreditNoteShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    Status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    Subtotal float64
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    SubtotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    Total float64
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    TotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    TotalTaxes []CreditNoteTotalTaxArgs
    The aggregate tax information for all line items.
    Type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    VoidedAt float64
    The time that the credit note was voided.
    amount number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    amount_shipping number
    This is the sum of all the shipping amounts.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    credit_amount number
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer.
    customer_balance_transaction string
    Customer balance transaction related to this credit note.
    discount_amount number
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discount_amounts list(object)
    The aggregate amounts calculated per discount for all line items.
    effective_at number
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    email_type string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    invoice string
    ID of the invoice.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    memo string
    Customer-facing text that appears on the credit note PDF.
    metadata map(string)
    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.
    number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object string
    String representing the object's type. Objects of the same type share the same value.
    out_of_band_amount number
    Amount that was credited outside of Stripe.
    post_payment_amount number
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    pre_payment_amount number
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretax_credit_amounts list(object)
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refund_amount number
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds list(object)
    Refunds related to this credit note.
    shipping_cost object
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotal_excluding_tax number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    total_excluding_tax number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    total_taxes list(object)
    The aggregate tax information for all line items.
    type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voided_at number
    The time that the credit note was voided.
    amount Double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    amountShipping Double
    This is the sum of all the shipping amounts.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditAmount Double
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer.
    customerBalanceTransaction String
    Customer balance transaction related to this credit note.
    discountAmount Double
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discountAmounts List<CreditNoteDiscountAmount>
    The aggregate amounts calculated per discount for all line items.
    effectiveAt Double
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    emailType String
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    invoice String
    ID of the invoice.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    memo String
    Customer-facing text that appears on the credit note PDF.
    metadata Map<String,String>
    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.
    number String
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object String
    String representing the object's type. Objects of the same type share the same value.
    outOfBandAmount Double
    Amount that was credited outside of Stripe.
    postPaymentAmount Double
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    prePaymentAmount Double
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretaxCreditAmounts List<CreditNotePretaxCreditAmount>
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    reason String
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refundAmount Double
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds List<CreditNoteRefund>
    Refunds related to this credit note.
    shippingCost CreditNoteShippingCost
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    status String
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal Double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total Double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    totalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    totalTaxes List<CreditNoteTotalTax>
    The aggregate tax information for all line items.
    type String
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voidedAt Double
    The time that the credit note was voided.
    amount number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    amountShipping number
    This is the sum of all the shipping amounts.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditAmount number
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    ID of the customer.
    customerBalanceTransaction string
    Customer balance transaction related to this credit note.
    discountAmount number
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discountAmounts CreditNoteDiscountAmount[]
    The aggregate amounts calculated per discount for all line items.
    effectiveAt number
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    emailType string
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    invoice string
    ID of the invoice.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    memo string
    Customer-facing text that appears on the credit note PDF.
    metadata {[key: string]: string}
    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.
    number string
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object string
    String representing the object's type. Objects of the same type share the same value.
    outOfBandAmount number
    Amount that was credited outside of Stripe.
    postPaymentAmount number
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    prePaymentAmount number
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretaxCreditAmounts CreditNotePretaxCreditAmount[]
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    reason string
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refundAmount number
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds CreditNoteRefund[]
    Refunds related to this credit note.
    shippingCost CreditNoteShippingCost
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    status string
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotalExcludingTax number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    totalExcludingTax number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    totalTaxes CreditNoteTotalTax[]
    The aggregate tax information for all line items.
    type string
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voidedAt number
    The time that the credit note was voided.
    amount float
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    amount_shipping float
    This is the sum of all the shipping amounts.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    credit_amount float
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    ID of the customer.
    customer_balance_transaction str
    Customer balance transaction related to this credit note.
    discount_amount float
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discount_amounts Sequence[CreditNoteDiscountAmountArgs]
    The aggregate amounts calculated per discount for all line items.
    effective_at float
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    email_type str
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    invoice str
    ID of the invoice.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    memo str
    Customer-facing text that appears on the credit note PDF.
    metadata Mapping[str, str]
    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.
    number str
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object str
    String representing the object's type. Objects of the same type share the same value.
    out_of_band_amount float
    Amount that was credited outside of Stripe.
    post_payment_amount float
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    pre_payment_amount float
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretax_credit_amounts Sequence[CreditNotePretaxCreditAmountArgs]
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    reason str
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refund_amount float
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds Sequence[CreditNoteRefundArgs]
    Refunds related to this credit note.
    shipping_cost CreditNoteShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    status str
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal float
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotal_excluding_tax float
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total float
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    total_excluding_tax float
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    total_taxes Sequence[CreditNoteTotalTaxArgs]
    The aggregate tax information for all line items.
    type str
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voided_at float
    The time that the credit note was voided.
    amount Number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
    amountShipping Number
    This is the sum of all the shipping amounts.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    creditAmount Number
    The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    ID of the customer.
    customerBalanceTransaction String
    Customer balance transaction related to this credit note.
    discountAmount Number
    The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
    discountAmounts List<Property Map>
    The aggregate amounts calculated per discount for all line items.
    effectiveAt Number
    The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
    emailType String
    Type of email to send to the customer, one of credit_note or none and the default is credit_note.
    invoice String
    ID of the invoice.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    memo String
    Customer-facing text that appears on the credit note PDF.
    metadata Map<String>
    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.
    number String
    A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
    object String
    String representing the object's type. Objects of the same type share the same value.
    outOfBandAmount Number
    Amount that was credited outside of Stripe.
    postPaymentAmount Number
    The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
    prePaymentAmount Number
    The amount of the credit note by which the invoice's amount_remaining and amount_due were reduced.
    pretaxCreditAmounts List<Property Map>
    The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
    reason String
    Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
    refundAmount Number
    The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
    refunds List<Property Map>
    Refunds related to this credit note.
    shippingCost Property Map
    The details of the cost of shipping, including the ShippingRate applied to the invoice.
    status String
    Status of this credit note, one of issued or void. Learn more about voiding credit notes.
    subtotal Number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
    subtotalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
    total Number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
    totalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
    totalTaxes List<Property Map>
    The aggregate tax information for all line items.
    type String
    Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
    voidedAt Number
    The time that the credit note was voided.

    Supporting Types

    CreditNoteDiscountAmount, CreditNoteDiscountAmountArgs

    Amount double
    The amount, in cents (or local equivalent), of the discount.
    Discount string
    The discount that was applied to get this discount amount.
    Amount float64
    The amount, in cents (or local equivalent), of the discount.
    Discount string
    The discount that was applied to get this discount amount.
    amount number
    The amount, in cents (or local equivalent), of the discount.
    discount string
    The discount that was applied to get this discount amount.
    amount Double
    The amount, in cents (or local equivalent), of the discount.
    discount String
    The discount that was applied to get this discount amount.
    amount number
    The amount, in cents (or local equivalent), of the discount.
    discount string
    The discount that was applied to get this discount amount.
    amount float
    The amount, in cents (or local equivalent), of the discount.
    discount str
    The discount that was applied to get this discount amount.
    amount Number
    The amount, in cents (or local equivalent), of the discount.
    discount String
    The discount that was applied to get this discount amount.

    CreditNotePretaxCreditAmount, CreditNotePretaxCreditAmountArgs

    Amount double
    The amount, in cents (or local equivalent), of the pretax credit amount.
    CreditBalanceTransaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    Discount string
    The discount that was applied to get this pretax credit amount.
    Type string
    Type of the pretax credit amount referenced.
    Amount float64
    The amount, in cents (or local equivalent), of the pretax credit amount.
    CreditBalanceTransaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    Discount string
    The discount that was applied to get this pretax credit amount.
    Type string
    Type of the pretax credit amount referenced.
    amount number
    The amount, in cents (or local equivalent), of the pretax credit amount.
    credit_balance_transaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    discount string
    The discount that was applied to get this pretax credit amount.
    type string
    Type of the pretax credit amount referenced.
    amount Double
    The amount, in cents (or local equivalent), of the pretax credit amount.
    creditBalanceTransaction String
    The credit balance transaction that was applied to get this pretax credit amount.
    discount String
    The discount that was applied to get this pretax credit amount.
    type String
    Type of the pretax credit amount referenced.
    amount number
    The amount, in cents (or local equivalent), of the pretax credit amount.
    creditBalanceTransaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    discount string
    The discount that was applied to get this pretax credit amount.
    type string
    Type of the pretax credit amount referenced.
    amount float
    The amount, in cents (or local equivalent), of the pretax credit amount.
    credit_balance_transaction str
    The credit balance transaction that was applied to get this pretax credit amount.
    discount str
    The discount that was applied to get this pretax credit amount.
    type str
    Type of the pretax credit amount referenced.
    amount Number
    The amount, in cents (or local equivalent), of the pretax credit amount.
    creditBalanceTransaction String
    The credit balance transaction that was applied to get this pretax credit amount.
    discount String
    The discount that was applied to get this pretax credit amount.
    type String
    Type of the pretax credit amount referenced.

    CreditNoteRefund, CreditNoteRefundArgs

    AmountRefunded double
    Amount of the refund that applies to this credit note, in cents (or local equivalent).
    PaymentRecordRefund CreditNoteRefundPaymentRecordRefund
    The PaymentRecord refund details associated with this credit note refund.
    Refund string
    ID of the refund.
    Type string
    Type of the refund, one of refund or payment_record_refund.
    AmountRefunded float64
    Amount of the refund that applies to this credit note, in cents (or local equivalent).
    PaymentRecordRefund CreditNoteRefundPaymentRecordRefund
    The PaymentRecord refund details associated with this credit note refund.
    Refund string
    ID of the refund.
    Type string
    Type of the refund, one of refund or payment_record_refund.
    amount_refunded number
    Amount of the refund that applies to this credit note, in cents (or local equivalent).
    payment_record_refund object
    The PaymentRecord refund details associated with this credit note refund.
    refund string
    ID of the refund.
    type string
    Type of the refund, one of refund or payment_record_refund.
    amountRefunded Double
    Amount of the refund that applies to this credit note, in cents (or local equivalent).
    paymentRecordRefund CreditNoteRefundPaymentRecordRefund
    The PaymentRecord refund details associated with this credit note refund.
    refund String
    ID of the refund.
    type String
    Type of the refund, one of refund or payment_record_refund.
    amountRefunded number
    Amount of the refund that applies to this credit note, in cents (or local equivalent).
    paymentRecordRefund CreditNoteRefundPaymentRecordRefund
    The PaymentRecord refund details associated with this credit note refund.
    refund string
    ID of the refund.
    type string
    Type of the refund, one of refund or payment_record_refund.
    amount_refunded float
    Amount of the refund that applies to this credit note, in cents (or local equivalent).
    payment_record_refund CreditNoteRefundPaymentRecordRefund
    The PaymentRecord refund details associated with this credit note refund.
    refund str
    ID of the refund.
    type str
    Type of the refund, one of refund or payment_record_refund.
    amountRefunded Number
    Amount of the refund that applies to this credit note, in cents (or local equivalent).
    paymentRecordRefund Property Map
    The PaymentRecord refund details associated with this credit note refund.
    refund String
    ID of the refund.
    type String
    Type of the refund, one of refund or payment_record_refund.

    CreditNoteRefundPaymentRecordRefund, CreditNoteRefundPaymentRecordRefundArgs

    PaymentRecord string
    ID of the payment record.
    RefundGroup string
    ID of the refund group.
    PaymentRecord string
    ID of the payment record.
    RefundGroup string
    ID of the refund group.
    payment_record string
    ID of the payment record.
    refund_group string
    ID of the refund group.
    paymentRecord String
    ID of the payment record.
    refundGroup String
    ID of the refund group.
    paymentRecord string
    ID of the payment record.
    refundGroup string
    ID of the refund group.
    payment_record str
    ID of the payment record.
    refund_group str
    ID of the refund group.
    paymentRecord String
    ID of the payment record.
    refundGroup String
    ID of the refund group.

    CreditNoteShippingCost, CreditNoteShippingCostArgs

    AmountSubtotal double
    Total shipping cost before any taxes are applied.
    AmountTax double
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    AmountTotal double
    Total shipping cost after taxes are applied.
    ShippingRate string
    The ID of the ShippingRate for this invoice.
    Taxes List<CreditNoteShippingCostTax>
    The taxes applied to the shipping rate.
    AmountSubtotal float64
    Total shipping cost before any taxes are applied.
    AmountTax float64
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    AmountTotal float64
    Total shipping cost after taxes are applied.
    ShippingRate string
    The ID of the ShippingRate for this invoice.
    Taxes []CreditNoteShippingCostTax
    The taxes applied to the shipping rate.
    amount_subtotal number
    Total shipping cost before any taxes are applied.
    amount_tax number
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amount_total number
    Total shipping cost after taxes are applied.
    shipping_rate string
    The ID of the ShippingRate for this invoice.
    taxes list(object)
    The taxes applied to the shipping rate.
    amountSubtotal Double
    Total shipping cost before any taxes are applied.
    amountTax Double
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amountTotal Double
    Total shipping cost after taxes are applied.
    shippingRate String
    The ID of the ShippingRate for this invoice.
    taxes List<CreditNoteShippingCostTax>
    The taxes applied to the shipping rate.
    amountSubtotal number
    Total shipping cost before any taxes are applied.
    amountTax number
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amountTotal number
    Total shipping cost after taxes are applied.
    shippingRate string
    The ID of the ShippingRate for this invoice.
    taxes CreditNoteShippingCostTax[]
    The taxes applied to the shipping rate.
    amount_subtotal float
    Total shipping cost before any taxes are applied.
    amount_tax float
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amount_total float
    Total shipping cost after taxes are applied.
    shipping_rate str
    The ID of the ShippingRate for this invoice.
    taxes Sequence[CreditNoteShippingCostTax]
    The taxes applied to the shipping rate.
    amountSubtotal Number
    Total shipping cost before any taxes are applied.
    amountTax Number
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amountTotal Number
    Total shipping cost after taxes are applied.
    shippingRate String
    The ID of the ShippingRate for this invoice.
    taxes List<Property Map>
    The taxes applied to the shipping rate.

    CreditNoteShippingCostTax, CreditNoteShippingCostTaxArgs

    Amount double
    Amount of tax applied for this rate.
    Rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    TaxabilityReason string
    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.
    TaxableAmount double
    The amount on which tax is calculated, in cents (or local equivalent).
    Amount float64
    Amount of tax applied for this rate.
    Rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    TaxabilityReason string
    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.
    TaxableAmount float64
    The amount on which tax is calculated, in cents (or local equivalent).
    amount number
    Amount of tax applied for this rate.
    rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxability_reason string
    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.
    taxable_amount number
    The amount on which tax is calculated, in cents (or local equivalent).
    amount Double
    Amount of tax applied for this rate.
    rate String
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxabilityReason String
    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.
    taxableAmount Double
    The amount on which tax is calculated, in cents (or local equivalent).
    amount number
    Amount of tax applied for this rate.
    rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxabilityReason string
    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.
    taxableAmount number
    The amount on which tax is calculated, in cents (or local equivalent).
    amount float
    Amount of tax applied for this rate.
    rate str
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxability_reason str
    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.
    taxable_amount float
    The amount on which tax is calculated, in cents (or local equivalent).
    amount Number
    Amount of tax applied for this rate.
    rate String
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxabilityReason String
    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.
    taxableAmount Number
    The amount on which tax is calculated, in cents (or local equivalent).

    CreditNoteTotalTax, CreditNoteTotalTaxArgs

    Amount double
    The amount of the tax, in cents (or local equivalent).
    TaxBehavior string
    Whether this tax is inclusive or exclusive.
    TaxRateDetails CreditNoteTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    TaxabilityReason string
    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.
    TaxableAmount double
    The amount on which tax is calculated, in cents (or local equivalent).
    Type string
    The type of tax information.
    Amount float64
    The amount of the tax, in cents (or local equivalent).
    TaxBehavior string
    Whether this tax is inclusive or exclusive.
    TaxRateDetails CreditNoteTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    TaxabilityReason string
    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.
    TaxableAmount float64
    The amount on which tax is calculated, in cents (or local equivalent).
    Type string
    The type of tax information.
    amount number
    The amount of the tax, in cents (or local equivalent).
    tax_behavior string
    Whether this tax is inclusive or exclusive.
    tax_rate_details object
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxability_reason string
    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.
    taxable_amount number
    The amount on which tax is calculated, in cents (or local equivalent).
    type string
    The type of tax information.
    amount Double
    The amount of the tax, in cents (or local equivalent).
    taxBehavior String
    Whether this tax is inclusive or exclusive.
    taxRateDetails CreditNoteTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxabilityReason String
    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.
    taxableAmount Double
    The amount on which tax is calculated, in cents (or local equivalent).
    type String
    The type of tax information.
    amount number
    The amount of the tax, in cents (or local equivalent).
    taxBehavior string
    Whether this tax is inclusive or exclusive.
    taxRateDetails CreditNoteTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxabilityReason string
    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.
    taxableAmount number
    The amount on which tax is calculated, in cents (or local equivalent).
    type string
    The type of tax information.
    amount float
    The amount of the tax, in cents (or local equivalent).
    tax_behavior str
    Whether this tax is inclusive or exclusive.
    tax_rate_details CreditNoteTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxability_reason str
    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.
    taxable_amount float
    The amount on which tax is calculated, in cents (or local equivalent).
    type str
    The type of tax information.
    amount Number
    The amount of the tax, in cents (or local equivalent).
    taxBehavior String
    Whether this tax is inclusive or exclusive.
    taxRateDetails Property Map
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxabilityReason String
    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.
    taxableAmount Number
    The amount on which tax is calculated, in cents (or local equivalent).
    type String
    The type of tax information.

    CreditNoteTotalTaxTaxRateDetails, CreditNoteTotalTaxTaxRateDetailsArgs

    TaxRate string
    ID of the tax rate
    TaxRate string
    ID of the tax rate
    tax_rate string
    ID of the tax rate
    taxRate String
    ID of the tax rate
    taxRate string
    ID of the tax rate
    tax_rate str
    ID of the tax rate
    taxRate String
    ID of the tax rate

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial