Customer

Stripe 0.3.0, Aug 14 26

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

Create Customer Resource

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

Constructor syntax

new Customer(name: string, args?: CustomerArgs, opts?: CustomResourceOptions);

@overload
def Customer(resource_name: str,
             args: Optional[CustomerArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Customer(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             addresses: Optional[Sequence[CustomerAddressArgs]] = None,
             balance: Optional[float] = None,
             business_name: Optional[str] = None,
             cash_balances: Optional[Sequence[CustomerCashBalanceArgs]] = None,
             default_source: Optional[str] = None,
             description: Optional[str] = None,
             email: Optional[str] = None,
             individual_name: Optional[str] = None,
             invoice_prefix: Optional[str] = None,
             invoice_settings: Optional[Sequence[CustomerInvoiceSettingArgs]] = None,
             metadata: Optional[Mapping[str, str]] = None,
             name: Optional[str] = None,
             next_invoice_sequence: Optional[float] = None,
             payment_method: Optional[str] = None,
             phone: Optional[str] = None,
             preferred_locales: Optional[Sequence[str]] = None,
             shippings: Optional[Sequence[CustomerShippingArgs]] = None,
             source: Optional[str] = None,
             tax_exempt: Optional[str] = None,
             tax_id_datas: Optional[Sequence[CustomerTaxIdDataArgs]] = None,
             taxes: Optional[Sequence[CustomerTaxArgs]] = None,
             test_clock: Optional[str] = None,
             validate: Optional[bool] = None)

func NewCustomer(ctx *Context, name string, args *CustomerArgs, opts ...ResourceOption) (*Customer, error)

public Customer(string name, CustomerArgs? args = null, CustomResourceOptions? opts = null)

public Customer(String name, CustomerArgs args)
public Customer(String name, CustomerArgs args, CustomResourceOptions options)

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

resource "stripe_customer" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args CustomerArgs: 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 CustomerArgs: 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 CustomerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CustomerArgs: 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 customerResource = new Stripe.Customer("customerResource", new()
{
    Addresses = new[]
    {
        new Stripe.Inputs.CustomerAddressArgs
        {
            City = "string",
            Country = "string",
            Line1 = "string",
            Line2 = "string",
            PostalCode = "string",
            State = "string",
        },
    },
    Balance = 0.0,
    BusinessName = "string",
    CashBalances = new[]
    {
        new Stripe.Inputs.CustomerCashBalanceArgs
        {
            Available = 
            {
                { "string", 0.0 },
            },
            Customer = "string",
            CustomerAccount = "string",
            Livemode = false,
            Object = "string",
            Settings = new[]
            {
                new Stripe.Inputs.CustomerCashBalanceSettingArgs
                {
                    ReconciliationMode = "string",
                    UsingMerchantDefault = false,
                },
            },
        },
    },
    DefaultSource = "string",
    Description = "string",
    Email = "string",
    IndividualName = "string",
    InvoicePrefix = "string",
    InvoiceSettings = new[]
    {
        new Stripe.Inputs.CustomerInvoiceSettingArgs
        {
            CustomFields = new[]
            {
                new Stripe.Inputs.CustomerInvoiceSettingCustomFieldArgs
                {
                    Name = "string",
                    Value = "string",
                },
            },
            DefaultPaymentMethod = "string",
            Footer = "string",
            RenderingOptions = new[]
            {
                new Stripe.Inputs.CustomerInvoiceSettingRenderingOptionArgs
                {
                    AmountTaxDisplay = "string",
                    Template = "string",
                },
            },
        },
    },
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    NextInvoiceSequence = 0.0,
    PaymentMethod = "string",
    Phone = "string",
    PreferredLocales = new[]
    {
        "string",
    },
    Shippings = new[]
    {
        new Stripe.Inputs.CustomerShippingArgs
        {
            Name = "string",
            Addresses = new[]
            {
                new Stripe.Inputs.CustomerShippingAddressArgs
                {
                    City = "string",
                    Country = "string",
                    Line1 = "string",
                    Line2 = "string",
                    PostalCode = "string",
                    State = "string",
                },
            },
            Carrier = "string",
            Phone = "string",
            TrackingNumber = "string",
        },
    },
    Source = "string",
    TaxExempt = "string",
    TaxIdDatas = new[]
    {
        new Stripe.Inputs.CustomerTaxIdDataArgs
        {
            Type = "string",
            Value = "string",
        },
    },
    Taxes = new[]
    {
        new Stripe.Inputs.CustomerTaxArgs
        {
            AutomaticTax = "string",
            IpAddress = "string",
            Locations = new[]
            {
                new Stripe.Inputs.CustomerTaxLocationArgs
                {
                    Country = "string",
                    Source = "string",
                    State = "string",
                },
            },
            Provider = "string",
            ValidateLocation = "string",
        },
    },
    TestClock = "string",
    Validate = false,
});

example, err := stripe.NewCustomer(ctx, "customerResource", &stripe.CustomerArgs{
	Addresses: stripe.CustomerAddressArray{
		&stripe.CustomerAddressArgs{
			City:       pulumi.String("string"),
			Country:    pulumi.String("string"),
			Line1:      pulumi.String("string"),
			Line2:      pulumi.String("string"),
			PostalCode: pulumi.String("string"),
			State:      pulumi.String("string"),
		},
	},
	Balance:      pulumi.Float64(0),
	BusinessName: pulumi.String("string"),
	CashBalances: stripe.CustomerCashBalanceArray{
		&stripe.CustomerCashBalanceArgs{
			Available: pulumi.Float64Map{
				"string": pulumi.Float64(0),
			},
			Customer:        pulumi.String("string"),
			CustomerAccount: pulumi.String("string"),
			Livemode:        pulumi.Bool(false),
			Object:          pulumi.String("string"),
			Settings: stripe.CustomerCashBalanceSettingArray{
				&stripe.CustomerCashBalanceSettingArgs{
					ReconciliationMode:   pulumi.String("string"),
					UsingMerchantDefault: pulumi.Bool(false),
				},
			},
		},
	},
	DefaultSource:  pulumi.String("string"),
	Description:    pulumi.String("string"),
	Email:          pulumi.String("string"),
	IndividualName: pulumi.String("string"),
	InvoicePrefix:  pulumi.String("string"),
	InvoiceSettings: stripe.CustomerInvoiceSettingArray{
		&stripe.CustomerInvoiceSettingArgs{
			CustomFields: stripe.CustomerInvoiceSettingCustomFieldArray{
				&stripe.CustomerInvoiceSettingCustomFieldArgs{
					Name:  pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
			DefaultPaymentMethod: pulumi.String("string"),
			Footer:               pulumi.String("string"),
			RenderingOptions: stripe.CustomerInvoiceSettingRenderingOptionArray{
				&stripe.CustomerInvoiceSettingRenderingOptionArgs{
					AmountTaxDisplay: pulumi.String("string"),
					Template:         pulumi.String("string"),
				},
			},
		},
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:                pulumi.String("string"),
	NextInvoiceSequence: pulumi.Float64(0),
	PaymentMethod:       pulumi.String("string"),
	Phone:               pulumi.String("string"),
	PreferredLocales: pulumi.StringArray{
		pulumi.String("string"),
	},
	Shippings: stripe.CustomerShippingArray{
		&stripe.CustomerShippingArgs{
			Name: pulumi.String("string"),
			Addresses: stripe.CustomerShippingAddressArray{
				&stripe.CustomerShippingAddressArgs{
					City:       pulumi.String("string"),
					Country:    pulumi.String("string"),
					Line1:      pulumi.String("string"),
					Line2:      pulumi.String("string"),
					PostalCode: pulumi.String("string"),
					State:      pulumi.String("string"),
				},
			},
			Carrier:        pulumi.String("string"),
			Phone:          pulumi.String("string"),
			TrackingNumber: pulumi.String("string"),
		},
	},
	Source:    pulumi.String("string"),
	TaxExempt: pulumi.String("string"),
	TaxIdDatas: stripe.CustomerTaxIdDataArray{
		&stripe.CustomerTaxIdDataArgs{
			Type:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Taxes: stripe.CustomerTaxArray{
		&stripe.CustomerTaxArgs{
			AutomaticTax: pulumi.String("string"),
			IpAddress:    pulumi.String("string"),
			Locations: stripe.CustomerTaxLocationArray{
				&stripe.CustomerTaxLocationArgs{
					Country: pulumi.String("string"),
					Source:  pulumi.String("string"),
					State:   pulumi.String("string"),
				},
			},
			Provider:         pulumi.String("string"),
			ValidateLocation: pulumi.String("string"),
		},
	},
	TestClock: pulumi.String("string"),
	Validate:  pulumi.Bool(false),
})

resource "stripe_customer" "customerResource" {
  lifecycle {
    create_before_destroy = true
  }
  addresses {
    city        = "string"
    country     = "string"
    line1       = "string"
    line2       = "string"
    postal_code = "string"
    state       = "string"
  }
  balance       = 0
  business_name = "string"
  cash_balances {
    available = {
      "string" = 0
    }
    customer         = "string"
    customer_account = "string"
    livemode         = false
    object           = "string"
    settings {
      reconciliation_mode    = "string"
      using_merchant_default = false
    }
  }
  default_source  = "string"
  description     = "string"
  email           = "string"
  individual_name = "string"
  invoice_prefix  = "string"
  invoice_settings {
    custom_fields {
      name  = "string"
      value = "string"
    }
    default_payment_method = "string"
    footer                 = "string"
    rendering_options {
      amount_tax_display = "string"
      template           = "string"
    }
  }
  metadata = {
    "string" = "string"
  }
  name                  = "string"
  next_invoice_sequence = 0
  payment_method        = "string"
  phone                 = "string"
  preferred_locales     = ["string"]
  shippings {
    name = "string"
    addresses {
      city        = "string"
      country     = "string"
      line1       = "string"
      line2       = "string"
      postal_code = "string"
      state       = "string"
    }
    carrier         = "string"
    phone           = "string"
    tracking_number = "string"
  }
  source     = "string"
  tax_exempt = "string"
  tax_id_datas {
    type  = "string"
    value = "string"
  }
  taxes {
    automatic_tax = "string"
    ip_address    = "string"
    locations {
      country = "string"
      source  = "string"
      state   = "string"
    }
    provider          = "string"
    validate_location = "string"
  }
  test_clock = "string"
  validate   = false
}

var customerResource = new Customer("customerResource", CustomerArgs.builder()
    .addresses(CustomerAddressArgs.builder()
        .city("string")
        .country("string")
        .line1("string")
        .line2("string")
        .postalCode("string")
        .state("string")
        .build())
    .balance(0.0)
    .businessName("string")
    .cashBalances(CustomerCashBalanceArgs.builder()
        .available(Map.of("string", 0.0))
        .customer("string")
        .customerAccount("string")
        .livemode(false)
        .object("string")
        .settings(CustomerCashBalanceSettingArgs.builder()
            .reconciliationMode("string")
            .usingMerchantDefault(false)
            .build())
        .build())
    .defaultSource("string")
    .description("string")
    .email("string")
    .individualName("string")
    .invoicePrefix("string")
    .invoiceSettings(CustomerInvoiceSettingArgs.builder()
        .customFields(CustomerInvoiceSettingCustomFieldArgs.builder()
            .name("string")
            .value("string")
            .build())
        .defaultPaymentMethod("string")
        .footer("string")
        .renderingOptions(CustomerInvoiceSettingRenderingOptionArgs.builder()
            .amountTaxDisplay("string")
            .template("string")
            .build())
        .build())
    .metadata(Map.of("string", "string"))
    .name("string")
    .nextInvoiceSequence(0.0)
    .paymentMethod("string")
    .phone("string")
    .preferredLocales("string")
    .shippings(CustomerShippingArgs.builder()
        .name("string")
        .addresses(CustomerShippingAddressArgs.builder()
            .city("string")
            .country("string")
            .line1("string")
            .line2("string")
            .postalCode("string")
            .state("string")
            .build())
        .carrier("string")
        .phone("string")
        .trackingNumber("string")
        .build())
    .source("string")
    .taxExempt("string")
    .taxIdDatas(CustomerTaxIdDataArgs.builder()
        .type("string")
        .value("string")
        .build())
    .taxes(CustomerTaxArgs.builder()
        .automaticTax("string")
        .ipAddress("string")
        .locations(CustomerTaxLocationArgs.builder()
            .country("string")
            .source("string")
            .state("string")
            .build())
        .provider("string")
        .validateLocation("string")
        .build())
    .testClock("string")
    .validate(false)
    .build());

customer_resource = stripe.Customer("customerResource",
    addresses=[{
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string",
    }],
    balance=float(0),
    business_name="string",
    cash_balances=[{
        "available": {
            "string": float(0),
        },
        "customer": "string",
        "customer_account": "string",
        "livemode": False,
        "object": "string",
        "settings": [{
            "reconciliation_mode": "string",
            "using_merchant_default": False,
        }],
    }],
    default_source="string",
    description="string",
    email="string",
    individual_name="string",
    invoice_prefix="string",
    invoice_settings=[{
        "custom_fields": [{
            "name": "string",
            "value": "string",
        }],
        "default_payment_method": "string",
        "footer": "string",
        "rendering_options": [{
            "amount_tax_display": "string",
            "template": "string",
        }],
    }],
    metadata={
        "string": "string",
    },
    name="string",
    next_invoice_sequence=float(0),
    payment_method="string",
    phone="string",
    preferred_locales=["string"],
    shippings=[{
        "name": "string",
        "addresses": [{
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string",
        }],
        "carrier": "string",
        "phone": "string",
        "tracking_number": "string",
    }],
    source="string",
    tax_exempt="string",
    tax_id_datas=[{
        "type": "string",
        "value": "string",
    }],
    taxes=[{
        "automatic_tax": "string",
        "ip_address": "string",
        "locations": [{
            "country": "string",
            "source": "string",
            "state": "string",
        }],
        "provider": "string",
        "validate_location": "string",
    }],
    test_clock="string",
    validate=False)

const customerResource = new stripe.Customer("customerResource", {
    addresses: [{
        city: "string",
        country: "string",
        line1: "string",
        line2: "string",
        postalCode: "string",
        state: "string",
    }],
    balance: 0,
    businessName: "string",
    cashBalances: [{
        available: {
            string: 0,
        },
        customer: "string",
        customerAccount: "string",
        livemode: false,
        object: "string",
        settings: [{
            reconciliationMode: "string",
            usingMerchantDefault: false,
        }],
    }],
    defaultSource: "string",
    description: "string",
    email: "string",
    individualName: "string",
    invoicePrefix: "string",
    invoiceSettings: [{
        customFields: [{
            name: "string",
            value: "string",
        }],
        defaultPaymentMethod: "string",
        footer: "string",
        renderingOptions: [{
            amountTaxDisplay: "string",
            template: "string",
        }],
    }],
    metadata: {
        string: "string",
    },
    name: "string",
    nextInvoiceSequence: 0,
    paymentMethod: "string",
    phone: "string",
    preferredLocales: ["string"],
    shippings: [{
        name: "string",
        addresses: [{
            city: "string",
            country: "string",
            line1: "string",
            line2: "string",
            postalCode: "string",
            state: "string",
        }],
        carrier: "string",
        phone: "string",
        trackingNumber: "string",
    }],
    source: "string",
    taxExempt: "string",
    taxIdDatas: [{
        type: "string",
        value: "string",
    }],
    taxes: [{
        automaticTax: "string",
        ipAddress: "string",
        locations: [{
            country: "string",
            source: "string",
            state: "string",
        }],
        provider: "string",
        validateLocation: "string",
    }],
    testClock: "string",
    validate: false,
});

type: stripe:Customer
properties:
    addresses:
        - city: string
          country: string
          line1: string
          line2: string
          postalCode: string
          state: string
    balance: 0
    businessName: string
    cashBalances:
        - available:
            string: 0
          customer: string
          customerAccount: string
          livemode: false
          object: string
          settings:
            - reconciliationMode: string
              usingMerchantDefault: false
    defaultSource: string
    description: string
    email: string
    individualName: string
    invoicePrefix: string
    invoiceSettings:
        - customFields:
            - name: string
              value: string
          defaultPaymentMethod: string
          footer: string
          renderingOptions:
            - amountTaxDisplay: string
              template: string
    metadata:
        string: string
    name: string
    nextInvoiceSequence: 0
    paymentMethod: string
    phone: string
    preferredLocales:
        - string
    shippings:
        - addresses:
            - city: string
              country: string
              line1: string
              line2: string
              postalCode: string
              state: string
          carrier: string
          name: string
          phone: string
          trackingNumber: string
    source: string
    taxExempt: string
    taxIdDatas:
        - type: string
          value: string
    taxes:
        - automaticTax: string
          ipAddress: string
          locations:
            - country: string
              source: string
              state: string
          provider: string
          validateLocation: string
    testClock: string
    validate: false

Customer 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 Customer resource accepts the following input properties:

Addresses List<CustomerAddress>

The customer's address.

Balance double

The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see invoice_credit_balance.

BusinessName string

The customer's business name.

CashBalances List<CustomerCashBalance>

The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The settings[reconciliation_mode] field describes if these funds apply to these payment intents manually or automatically.

DefaultSource string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

Description string

An arbitrary string attached to the object. Often useful for displaying to users.

Email string

The customer's email address.

IndividualName string

The customer's individual name.

InvoicePrefix string

The prefix for the customer used to generate unique invoice numbers.

InvoiceSettings List<CustomerInvoiceSetting>

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.

Name string

The customer's full name or business name.

NextInvoiceSequence double

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

PaymentMethod string

Phone string

The customer's phone number.

PreferredLocales List<string>

The customer's preferred locales (languages), ordered by preference.

Shippings List<CustomerShipping>

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

Source string

TaxExempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

TaxIdDatas List<CustomerTaxIdData>

The customer's tax IDs.

Taxes List<CustomerTax>

TestClock string

ID of the test clock that this customer belongs to.

Validate bool

Addresses []CustomerAddressArgs

The customer's address.

Balance float64

BusinessName string

The customer's business name.

CashBalances []CustomerCashBalanceArgs

DefaultSource string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

Description string

An arbitrary string attached to the object. Often useful for displaying to users.

Email string

The customer's email address.

IndividualName string

The customer's individual name.

InvoicePrefix string

The prefix for the customer used to generate unique invoice numbers.

InvoiceSettings []CustomerInvoiceSettingArgs

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.

Name string

The customer's full name or business name.

NextInvoiceSequence float64

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

PaymentMethod string

Phone string

The customer's phone number.

PreferredLocales []string

The customer's preferred locales (languages), ordered by preference.

Shippings []CustomerShippingArgs

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

Source string

TaxExempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

TaxIdDatas []CustomerTaxIdDataArgs

The customer's tax IDs.

Taxes []CustomerTaxArgs

TestClock string

ID of the test clock that this customer belongs to.

Validate bool

addresses list(object)

The customer's address.

balance number

business_name string

The customer's business name.

cash_balances list(object)

default_source string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

description string

An arbitrary string attached to the object. Often useful for displaying to users.

email string

The customer's email address.

individual_name string

The customer's individual name.

invoice_prefix string

The prefix for the customer used to generate unique invoice numbers.

invoice_settings list(object)

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.

name string

The customer's full name or business name.

next_invoice_sequence number

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

payment_method string

phone string

The customer's phone number.

preferred_locales list(string)

The customer's preferred locales (languages), ordered by preference.

shippings list(object)

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source string

tax_exempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

tax_id_datas list(object)

The customer's tax IDs.

taxes list(object)

test_clock string

ID of the test clock that this customer belongs to.

validate bool

addresses List<CustomerAddress>

The customer's address.

balance Double

businessName String

The customer's business name.

cashBalances List<CustomerCashBalance>

defaultSource String

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

description String

An arbitrary string attached to the object. Often useful for displaying to users.

email String

The customer's email address.

individualName String

The customer's individual name.

invoicePrefix String

The prefix for the customer used to generate unique invoice numbers.

invoiceSettings List<CustomerInvoiceSetting>

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.

name String

The customer's full name or business name.

nextInvoiceSequence Double

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

paymentMethod String

phone String

The customer's phone number.

preferredLocales List<String>

The customer's preferred locales (languages), ordered by preference.

shippings List<CustomerShipping>

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source String

taxExempt String

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

taxIdDatas List<CustomerTaxIdData>

The customer's tax IDs.

taxes List<CustomerTax>

testClock String

ID of the test clock that this customer belongs to.

validate Boolean

addresses CustomerAddress[]

The customer's address.

balance number

businessName string

The customer's business name.

cashBalances CustomerCashBalance[]

defaultSource string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

description string

An arbitrary string attached to the object. Often useful for displaying to users.

email string

The customer's email address.

individualName string

The customer's individual name.

invoicePrefix string

The prefix for the customer used to generate unique invoice numbers.

invoiceSettings CustomerInvoiceSetting[]

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.

name string

The customer's full name or business name.

nextInvoiceSequence number

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

paymentMethod string

phone string

The customer's phone number.

preferredLocales string[]

The customer's preferred locales (languages), ordered by preference.

shippings CustomerShipping[]

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source string

taxExempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

taxIdDatas CustomerTaxIdData[]

The customer's tax IDs.

taxes CustomerTax[]

testClock string

ID of the test clock that this customer belongs to.

validate boolean

addresses Sequence[CustomerAddressArgs]

The customer's address.

balance float

business_name str

The customer's business name.

cash_balances Sequence[CustomerCashBalanceArgs]

default_source str

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

description str

An arbitrary string attached to the object. Often useful for displaying to users.

email str

The customer's email address.

individual_name str

The customer's individual name.

invoice_prefix str

The prefix for the customer used to generate unique invoice numbers.

invoice_settings Sequence[CustomerInvoiceSettingArgs]

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.

name str

The customer's full name or business name.

next_invoice_sequence float

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

payment_method str

phone str

The customer's phone number.

preferred_locales Sequence[str]

The customer's preferred locales (languages), ordered by preference.

shippings Sequence[CustomerShippingArgs]

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source str

tax_exempt str

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

tax_id_datas Sequence[CustomerTaxIdDataArgs]

The customer's tax IDs.

taxes Sequence[CustomerTaxArgs]

test_clock str

ID of the test clock that this customer belongs to.

validate bool

addresses List<Property Map>

The customer's address.

balance Number

businessName String

The customer's business name.

cashBalances List<Property Map>

defaultSource String

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

description String

An arbitrary string attached to the object. Often useful for displaying to users.

email String

The customer's email address.

individualName String

The customer's individual name.

invoicePrefix String

The prefix for the customer used to generate unique invoice numbers.

invoiceSettings List<Property Map>

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.

name String

The customer's full name or business name.

nextInvoiceSequence Number

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

paymentMethod String

phone String

The customer's phone number.

preferredLocales List<String>

The customer's preferred locales (languages), ordered by preference.

shippings List<Property Map>

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source String

taxExempt String

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

taxIdDatas List<Property Map>

The customer's tax IDs.

taxes List<Property Map>

testClock String

ID of the test clock that this customer belongs to.

validate Boolean

Outputs

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

Created double

Time at which the object was created. Measured in seconds since the Unix epoch.

Currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

CustomerAccount string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

Delinquent bool

Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the invoice.due_date will set this field to true.

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

If you care whether the customer has paid their most recent subscription invoice, use subscription.status instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to false.

Discount string

Describes the current discount active on the customer, if there is one.

Id string

The provider-assigned unique ID for this managed resource.

InvoiceCreditBalance Dictionary<string, double>

The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.

Livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

Object string

String representing the object's type. Objects of the same type share the same value.

Created float64

Time at which the object was created. Measured in seconds since the Unix epoch.

Currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

CustomerAccount string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

Delinquent bool

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

Discount string

Describes the current discount active on the customer, if there is one.

Id string

The provider-assigned unique ID for this managed resource.

InvoiceCreditBalance map[string]float64

Livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

Object string

String representing the object's type. Objects of the same type share the same value.

created number

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customer_account string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

delinquent bool

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

discount string

Describes the current discount active on the customer, if there is one.

id string

The provider-assigned unique ID for this managed resource.

invoice_credit_balance map(number)

livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object string

String representing the object's type. Objects of the same type share the same value.

created Double

Time at which the object was created. Measured in seconds since the Unix epoch.

currency String

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customerAccount String

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

delinquent Boolean

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

discount String

Describes the current discount active on the customer, if there is one.

id String

The provider-assigned unique ID for this managed resource.

invoiceCreditBalance Map<String,Double>

livemode Boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object String

String representing the object's type. Objects of the same type share the same value.

created number

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customerAccount string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

delinquent boolean

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

discount string

Describes the current discount active on the customer, if there is one.

id string

The provider-assigned unique ID for this managed resource.

invoiceCreditBalance {[key: string]: number}

livemode boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object string

String representing the object's type. Objects of the same type share the same value.

created float

Time at which the object was created. Measured in seconds since the Unix epoch.

currency str

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customer_account str

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

delinquent bool

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

discount str

Describes the current discount active on the customer, if there is one.

id str

The provider-assigned unique ID for this managed resource.

invoice_credit_balance Mapping[str, float]

livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object str

String representing the object's type. Objects of the same type share the same value.

created Number

Time at which the object was created. Measured in seconds since the Unix epoch.

currency String

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customerAccount String

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

delinquent Boolean

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

discount String

Describes the current discount active on the customer, if there is one.

id String

The provider-assigned unique ID for this managed resource.

invoiceCreditBalance Map<Number>

livemode Boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object String

String representing the object's type. Objects of the same type share the same value.

Look up Existing Customer Resource

Get an existing Customer 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?: CustomerState, opts?: CustomResourceOptions): Customer

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[CustomerAddressArgs]] = None,
        balance: Optional[float] = None,
        business_name: Optional[str] = None,
        cash_balances: Optional[Sequence[CustomerCashBalanceArgs]] = None,
        created: Optional[float] = None,
        currency: Optional[str] = None,
        customer_account: Optional[str] = None,
        default_source: Optional[str] = None,
        delinquent: Optional[bool] = None,
        description: Optional[str] = None,
        discount: Optional[str] = None,
        email: Optional[str] = None,
        individual_name: Optional[str] = None,
        invoice_credit_balance: Optional[Mapping[str, float]] = None,
        invoice_prefix: Optional[str] = None,
        invoice_settings: Optional[Sequence[CustomerInvoiceSettingArgs]] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        next_invoice_sequence: Optional[float] = None,
        object: Optional[str] = None,
        payment_method: Optional[str] = None,
        phone: Optional[str] = None,
        preferred_locales: Optional[Sequence[str]] = None,
        shippings: Optional[Sequence[CustomerShippingArgs]] = None,
        source: Optional[str] = None,
        tax_exempt: Optional[str] = None,
        tax_id_datas: Optional[Sequence[CustomerTaxIdDataArgs]] = None,
        taxes: Optional[Sequence[CustomerTaxArgs]] = None,
        test_clock: Optional[str] = None,
        validate: Optional[bool] = None) -> Customer

func GetCustomer(ctx *Context, name string, id IDInput, state *CustomerState, opts ...ResourceOption) (*Customer, error)

public static Customer Get(string name, Input<string> id, CustomerState? state, CustomResourceOptions? opts = null)

public static Customer get(String name, Output<String> id, CustomerState state, CustomResourceOptions options)

resources:  _:    type: stripe:Customer    get:      id: ${id}

import {
  to = stripe_customer.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:

Addresses List<CustomerAddress>

The customer's address.

Balance double

BusinessName string

The customer's business name.

CashBalances List<CustomerCashBalance>

Created double

Time at which the object was created. Measured in seconds since the Unix epoch.

Currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

CustomerAccount string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

DefaultSource string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

Delinquent bool

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

Description string

An arbitrary string attached to the object. Often useful for displaying to users.

Discount string

Describes the current discount active on the customer, if there is one.

Email string

The customer's email address.

IndividualName string

The customer's individual name.

InvoiceCreditBalance Dictionary<string, double>

InvoicePrefix string

The prefix for the customer used to generate unique invoice numbers.

InvoiceSettings List<CustomerInvoiceSetting>

Livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

Name string

The customer's full name or business name.

NextInvoiceSequence double

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

Object string

String representing the object's type. Objects of the same type share the same value.

PaymentMethod string

Phone string

The customer's phone number.

PreferredLocales List<string>

The customer's preferred locales (languages), ordered by preference.

Shippings List<CustomerShipping>

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

Source string

TaxExempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

TaxIdDatas List<CustomerTaxIdData>

The customer's tax IDs.

Taxes List<CustomerTax>

TestClock string

ID of the test clock that this customer belongs to.

Validate bool

Addresses []CustomerAddressArgs

The customer's address.

Balance float64

BusinessName string

The customer's business name.

CashBalances []CustomerCashBalanceArgs

Created float64

Time at which the object was created. Measured in seconds since the Unix epoch.

Currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

CustomerAccount string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

DefaultSource string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

Delinquent bool

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

Description string

An arbitrary string attached to the object. Often useful for displaying to users.

Discount string

Describes the current discount active on the customer, if there is one.

Email string

The customer's email address.

IndividualName string

The customer's individual name.

InvoiceCreditBalance map[string]float64

InvoicePrefix string

The prefix for the customer used to generate unique invoice numbers.

InvoiceSettings []CustomerInvoiceSettingArgs

Livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

Name string

The customer's full name or business name.

NextInvoiceSequence float64

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

Object string

String representing the object's type. Objects of the same type share the same value.

PaymentMethod string

Phone string

The customer's phone number.

PreferredLocales []string

The customer's preferred locales (languages), ordered by preference.

Shippings []CustomerShippingArgs

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

Source string

TaxExempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

TaxIdDatas []CustomerTaxIdDataArgs

The customer's tax IDs.

Taxes []CustomerTaxArgs

TestClock string

ID of the test clock that this customer belongs to.

Validate bool

addresses list(object)

The customer's address.

balance number

business_name string

The customer's business name.

cash_balances list(object)

created number

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customer_account string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

default_source string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

delinquent bool

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

description string

An arbitrary string attached to the object. Often useful for displaying to users.

discount string

Describes the current discount active on the customer, if there is one.

email string

The customer's email address.

individual_name string

The customer's individual name.

invoice_credit_balance map(number)

invoice_prefix string

The prefix for the customer used to generate unique invoice numbers.

invoice_settings list(object)

livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

name string

The customer's full name or business name.

next_invoice_sequence number

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

object string

String representing the object's type. Objects of the same type share the same value.

payment_method string

phone string

The customer's phone number.

preferred_locales list(string)

The customer's preferred locales (languages), ordered by preference.

shippings list(object)

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source string

tax_exempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

tax_id_datas list(object)

The customer's tax IDs.

taxes list(object)

test_clock string

ID of the test clock that this customer belongs to.

validate bool

addresses List<CustomerAddress>

The customer's address.

balance Double

businessName String

The customer's business name.

cashBalances List<CustomerCashBalance>

created Double

Time at which the object was created. Measured in seconds since the Unix epoch.

currency String

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customerAccount String

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

defaultSource String

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

delinquent Boolean

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

description String

An arbitrary string attached to the object. Often useful for displaying to users.

discount String

Describes the current discount active on the customer, if there is one.

email String

The customer's email address.

individualName String

The customer's individual name.

invoiceCreditBalance Map<String,Double>

invoicePrefix String

The prefix for the customer used to generate unique invoice numbers.

invoiceSettings List<CustomerInvoiceSetting>

livemode Boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

name String

The customer's full name or business name.

nextInvoiceSequence Double

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

object String

String representing the object's type. Objects of the same type share the same value.

paymentMethod String

phone String

The customer's phone number.

preferredLocales List<String>

The customer's preferred locales (languages), ordered by preference.

shippings List<CustomerShipping>

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source String

taxExempt String

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

taxIdDatas List<CustomerTaxIdData>

The customer's tax IDs.

taxes List<CustomerTax>

testClock String

ID of the test clock that this customer belongs to.

validate Boolean

addresses CustomerAddress[]

The customer's address.

balance number

businessName string

The customer's business name.

cashBalances CustomerCashBalance[]

created number

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customerAccount string

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

defaultSource string

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

delinquent boolean

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

description string

An arbitrary string attached to the object. Often useful for displaying to users.

discount string

Describes the current discount active on the customer, if there is one.

email string

The customer's email address.

individualName string

The customer's individual name.

invoiceCreditBalance {[key: string]: number}

invoicePrefix string

The prefix for the customer used to generate unique invoice numbers.

invoiceSettings CustomerInvoiceSetting[]

livemode boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

name string

The customer's full name or business name.

nextInvoiceSequence number

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

object string

String representing the object's type. Objects of the same type share the same value.

paymentMethod string

phone string

The customer's phone number.

preferredLocales string[]

The customer's preferred locales (languages), ordered by preference.

shippings CustomerShipping[]

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source string

taxExempt string

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

taxIdDatas CustomerTaxIdData[]

The customer's tax IDs.

taxes CustomerTax[]

testClock string

ID of the test clock that this customer belongs to.

validate boolean

addresses Sequence[CustomerAddressArgs]

The customer's address.

balance float

business_name str

The customer's business name.

cash_balances Sequence[CustomerCashBalanceArgs]

created float

Time at which the object was created. Measured in seconds since the Unix epoch.

currency str

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customer_account str

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

default_source str

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

delinquent bool

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

description str

An arbitrary string attached to the object. Often useful for displaying to users.

discount str

Describes the current discount active on the customer, if there is one.

email str

The customer's email address.

individual_name str

The customer's individual name.

invoice_credit_balance Mapping[str, float]

invoice_prefix str

The prefix for the customer used to generate unique invoice numbers.

invoice_settings Sequence[CustomerInvoiceSettingArgs]

livemode bool

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

name str

The customer's full name or business name.

next_invoice_sequence float

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

object str

String representing the object's type. Objects of the same type share the same value.

payment_method str

phone str

The customer's phone number.

preferred_locales Sequence[str]

The customer's preferred locales (languages), ordered by preference.

shippings Sequence[CustomerShippingArgs]

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source str

tax_exempt str

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

tax_id_datas Sequence[CustomerTaxIdDataArgs]

The customer's tax IDs.

taxes Sequence[CustomerTaxArgs]

test_clock str

ID of the test clock that this customer belongs to.

validate bool

addresses List<Property Map>

The customer's address.

balance Number

businessName String

The customer's business name.

cashBalances List<Property Map>

created Number

Time at which the object was created. Measured in seconds since the Unix epoch.

currency String

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

customerAccount String

The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

defaultSource String

ID of the default payment source for the customer.

If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

delinquent Boolean

If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

description String

An arbitrary string attached to the object. Often useful for displaying to users.

discount String

Describes the current discount active on the customer, if there is one.

email String

The customer's email address.

individualName String

The customer's individual name.

invoiceCreditBalance Map<Number>

invoicePrefix String

The prefix for the customer used to generate unique invoice numbers.

invoiceSettings List<Property Map>

livemode Boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

name String

The customer's full name or business name.

nextInvoiceSequence Number

The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

object String

String representing the object's type. Objects of the same type share the same value.

paymentMethod String

phone String

The customer's phone number.

preferredLocales List<String>

The customer's preferred locales (languages), ordered by preference.

shippings List<Property Map>

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

source String

taxExempt String

Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

taxIdDatas List<Property Map>

The customer's tax IDs.

taxes List<Property Map>

testClock String

ID of the test clock that this customer belongs to.

validate Boolean

Supporting Types

CustomerAddress, CustomerAddressArgs

City string: City, district, suburb, town, or village.
Country string: Two-letter country code (ISO 3166-1 alpha-2).
Line1 string: Address line 1, such as the street, PO Box, or company name.
Line2 string: Address line 2, such as the apartment, suite, unit, or building.
PostalCode string: ZIP or postal code.
State string: State, county, province, or region (ISO 3166-2).

City string: City, district, suburb, town, or village.
Country string: Two-letter country code (ISO 3166-1 alpha-2).
Line1 string: Address line 1, such as the street, PO Box, or company name.
Line2 string: Address line 2, such as the apartment, suite, unit, or building.
PostalCode string: ZIP or postal code.
State string: State, county, province, or region (ISO 3166-2).

city string: City, district, suburb, town, or village.
country string: Two-letter country code (ISO 3166-1 alpha-2).
line1 string: Address line 1, such as the street, PO Box, or company name.
line2 string: Address line 2, such as the apartment, suite, unit, or building.
postal_code string: ZIP or postal code.
state string: State, county, province, or region (ISO 3166-2).

city String: City, district, suburb, town, or village.
country String: Two-letter country code (ISO 3166-1 alpha-2).
line1 String: Address line 1, such as the street, PO Box, or company name.
line2 String: Address line 2, such as the apartment, suite, unit, or building.
postalCode String: ZIP or postal code.
state String: State, county, province, or region (ISO 3166-2).

city string: City, district, suburb, town, or village.
country string: Two-letter country code (ISO 3166-1 alpha-2).
line1 string: Address line 1, such as the street, PO Box, or company name.
line2 string: Address line 2, such as the apartment, suite, unit, or building.
postalCode string: ZIP or postal code.
state string: State, county, province, or region (ISO 3166-2).

city str: City, district, suburb, town, or village.
country str: Two-letter country code (ISO 3166-1 alpha-2).
line1 str: Address line 1, such as the street, PO Box, or company name.
line2 str: Address line 2, such as the apartment, suite, unit, or building.
postal_code str: ZIP or postal code.
state str: State, county, province, or region (ISO 3166-2).

city String: City, district, suburb, town, or village.
country String: Two-letter country code (ISO 3166-1 alpha-2).
line1 String: Address line 1, such as the street, PO Box, or company name.
line2 String: Address line 2, such as the apartment, suite, unit, or building.
postalCode String: ZIP or postal code.
state String: State, county, province, or region (ISO 3166-2).

CustomerCashBalance, CustomerCashBalanceArgs

Available Dictionary<string, double>: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
Customer string: The ID of the customer whose cash balance this object represents.
CustomerAccount string: The ID of an Account representing a customer whose cash balance this object represents.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
Settings List<CustomerCashBalanceSetting>

Available map[string]float64: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
Customer string: The ID of the customer whose cash balance this object represents.
CustomerAccount string: The ID of an Account representing a customer whose cash balance this object represents.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
Settings []CustomerCashBalanceSetting

available map(number): A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
customer string: The ID of the customer whose cash balance this object represents.
customer_account string: The ID of an Account representing a customer whose cash balance this object represents.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
settings list(object)

available Map<String,Double>: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
customer String: The ID of the customer whose cash balance this object represents.
customerAccount String: The ID of an Account representing a customer whose cash balance this object represents.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
settings List<CustomerCashBalanceSetting>

available {[key: string]: number}: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
customer string: The ID of the customer whose cash balance this object represents.
customerAccount string: The ID of an Account representing a customer whose cash balance this object represents.
livemode boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
settings CustomerCashBalanceSetting[]

available Mapping[str, float]: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
customer str: The ID of the customer whose cash balance this object represents.
customer_account str: The ID of an Account representing a customer whose cash balance this object represents.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object str: String representing the object's type. Objects of the same type share the same value.
settings Sequence[CustomerCashBalanceSetting]

available Map<Number>: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
customer String: The ID of the customer whose cash balance this object represents.
customerAccount String: The ID of an Account representing a customer whose cash balance this object represents.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
settings List<Property Map>

CustomerCashBalanceSetting, CustomerCashBalanceSettingArgs

ReconciliationMode string: The configuration for how funds that land in the customer cash balance are reconciled.
UsingMerchantDefault bool: A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

ReconciliationMode string: The configuration for how funds that land in the customer cash balance are reconciled.
UsingMerchantDefault bool: A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

reconciliation_mode string: The configuration for how funds that land in the customer cash balance are reconciled.
using_merchant_default bool: A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

reconciliationMode String: The configuration for how funds that land in the customer cash balance are reconciled.
usingMerchantDefault Boolean: A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

reconciliationMode string: The configuration for how funds that land in the customer cash balance are reconciled.
usingMerchantDefault boolean: A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

reconciliation_mode str: The configuration for how funds that land in the customer cash balance are reconciled.
using_merchant_default bool: A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

reconciliationMode String: The configuration for how funds that land in the customer cash balance are reconciled.
usingMerchantDefault Boolean: A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance

CustomerInvoiceSetting, CustomerInvoiceSettingArgs

CustomFields List<CustomerInvoiceSettingCustomField>: Default custom fields to be displayed on invoices for this customer.
DefaultPaymentMethod string: ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
Footer string: Default footer to be displayed on invoices for this customer.
RenderingOptions List<CustomerInvoiceSettingRenderingOption>: Default options for invoice PDF rendering for this customer.

CustomFields []CustomerInvoiceSettingCustomField: Default custom fields to be displayed on invoices for this customer.
DefaultPaymentMethod string: ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
Footer string: Default footer to be displayed on invoices for this customer.
RenderingOptions []CustomerInvoiceSettingRenderingOption: Default options for invoice PDF rendering for this customer.

custom_fields list(object): Default custom fields to be displayed on invoices for this customer.
default_payment_method string: ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
footer string: Default footer to be displayed on invoices for this customer.
rendering_options list(object): Default options for invoice PDF rendering for this customer.

customFields List<CustomerInvoiceSettingCustomField>: Default custom fields to be displayed on invoices for this customer.
defaultPaymentMethod String: ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
footer String: Default footer to be displayed on invoices for this customer.
renderingOptions List<CustomerInvoiceSettingRenderingOption>: Default options for invoice PDF rendering for this customer.

customFields CustomerInvoiceSettingCustomField[]: Default custom fields to be displayed on invoices for this customer.
defaultPaymentMethod string: ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
footer string: Default footer to be displayed on invoices for this customer.
renderingOptions CustomerInvoiceSettingRenderingOption[]: Default options for invoice PDF rendering for this customer.

custom_fields Sequence[CustomerInvoiceSettingCustomField]: Default custom fields to be displayed on invoices for this customer.
default_payment_method str: ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
footer str: Default footer to be displayed on invoices for this customer.
rendering_options Sequence[CustomerInvoiceSettingRenderingOption]: Default options for invoice PDF rendering for this customer.

customFields List<Property Map>: Default custom fields to be displayed on invoices for this customer.
defaultPaymentMethod String: ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
footer String: Default footer to be displayed on invoices for this customer.
renderingOptions List<Property Map>: Default options for invoice PDF rendering for this customer.

CustomerInvoiceSettingCustomField, CustomerInvoiceSettingCustomFieldArgs

Name string: The name of the custom field.
Value string: The value of the custom field.

Name string: The name of the custom field.
Value string: The value of the custom field.

name string: The name of the custom field.
value string: The value of the custom field.

name String: The name of the custom field.
value String: The value of the custom field.

name string: The name of the custom field.
value string: The value of the custom field.

name str: The name of the custom field.
value str: The value of the custom field.

name String: The name of the custom field.
value String: The value of the custom field.

CustomerInvoiceSettingRenderingOption, CustomerInvoiceSettingRenderingOptionArgs

AmountTaxDisplay string: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
Template string: ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

AmountTaxDisplay string: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
Template string: ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

amount_tax_display string: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
template string: ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

amountTaxDisplay String: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
template String: ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

amountTaxDisplay string: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
template string: ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

amount_tax_display str: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
template str: ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

amountTaxDisplay String: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
template String: ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.

CustomerShipping, CustomerShippingArgs

Name string: Recipient name.
Addresses List<CustomerShippingAddress>
Carrier string: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
Phone string: Recipient phone (including extension).
TrackingNumber string: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

Name string: Recipient name.
Addresses []CustomerShippingAddress
Carrier string: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
Phone string: Recipient phone (including extension).
TrackingNumber string: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

name string: Recipient name.
addresses list(object)
carrier string: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
phone string: Recipient phone (including extension).
tracking_number string: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

name String: Recipient name.
addresses List<CustomerShippingAddress>
carrier String: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
phone String: Recipient phone (including extension).
trackingNumber String: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

name string: Recipient name.
addresses CustomerShippingAddress[]
carrier string: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
phone string: Recipient phone (including extension).
trackingNumber string: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

name str: Recipient name.
addresses Sequence[CustomerShippingAddress]
carrier str: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
phone str: Recipient phone (including extension).
tracking_number str: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

name String: Recipient name.
addresses List<Property Map>
carrier String: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
phone String: Recipient phone (including extension).
trackingNumber String: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

CustomerShippingAddress, CustomerShippingAddressArgs

City string: City, district, suburb, town, or village.
Country string: Two-letter country code (ISO 3166-1 alpha-2).
Line1 string: Address line 1, such as the street, PO Box, or company name.
Line2 string: Address line 2, such as the apartment, suite, unit, or building.
PostalCode string: ZIP or postal code.
State string: State, county, province, or region (ISO 3166-2).

City string: City, district, suburb, town, or village.
Country string: Two-letter country code (ISO 3166-1 alpha-2).
Line1 string: Address line 1, such as the street, PO Box, or company name.
Line2 string: Address line 2, such as the apartment, suite, unit, or building.
PostalCode string: ZIP or postal code.
State string: State, county, province, or region (ISO 3166-2).

city string: City, district, suburb, town, or village.
country string: Two-letter country code (ISO 3166-1 alpha-2).
line1 string: Address line 1, such as the street, PO Box, or company name.
line2 string: Address line 2, such as the apartment, suite, unit, or building.
postal_code string: ZIP or postal code.
state string: State, county, province, or region (ISO 3166-2).

city String: City, district, suburb, town, or village.
country String: Two-letter country code (ISO 3166-1 alpha-2).
line1 String: Address line 1, such as the street, PO Box, or company name.
line2 String: Address line 2, such as the apartment, suite, unit, or building.
postalCode String: ZIP or postal code.
state String: State, county, province, or region (ISO 3166-2).

city string: City, district, suburb, town, or village.
country string: Two-letter country code (ISO 3166-1 alpha-2).
line1 string: Address line 1, such as the street, PO Box, or company name.
line2 string: Address line 2, such as the apartment, suite, unit, or building.
postalCode string: ZIP or postal code.
state string: State, county, province, or region (ISO 3166-2).

city str: City, district, suburb, town, or village.
country str: Two-letter country code (ISO 3166-1 alpha-2).
line1 str: Address line 1, such as the street, PO Box, or company name.
line2 str: Address line 2, such as the apartment, suite, unit, or building.
postal_code str: ZIP or postal code.
state str: State, county, province, or region (ISO 3166-2).

city String: City, district, suburb, town, or village.
country String: Two-letter country code (ISO 3166-1 alpha-2).
line1 String: Address line 1, such as the street, PO Box, or company name.
line2 String: Address line 2, such as the apartment, suite, unit, or building.
postalCode String: ZIP or postal code.
state String: State, county, province, or region (ISO 3166-2).

CustomerTax, CustomerTaxArgs

AutomaticTax string: Surfaces if automatic tax computation is possible given the current customer location information.
IpAddress string: A recent IP address of the customer used for tax reporting and tax location inference.
Locations List<CustomerTaxLocation>: The identified tax location of the customer.
Provider string: The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.
ValidateLocation string: A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.

AutomaticTax string: Surfaces if automatic tax computation is possible given the current customer location information.
IpAddress string: A recent IP address of the customer used for tax reporting and tax location inference.
Locations []CustomerTaxLocation: The identified tax location of the customer.
Provider string: The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.
ValidateLocation string: A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.

automatic_tax string: Surfaces if automatic tax computation is possible given the current customer location information.
ip_address string: A recent IP address of the customer used for tax reporting and tax location inference.
locations list(object): The identified tax location of the customer.
provider string: The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.
validate_location string: A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.

automaticTax String: Surfaces if automatic tax computation is possible given the current customer location information.
ipAddress String: A recent IP address of the customer used for tax reporting and tax location inference.
locations List<CustomerTaxLocation>: The identified tax location of the customer.
provider String: The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.
validateLocation String: A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.

automaticTax string: Surfaces if automatic tax computation is possible given the current customer location information.
ipAddress string: A recent IP address of the customer used for tax reporting and tax location inference.
locations CustomerTaxLocation[]: The identified tax location of the customer.
provider string: The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.
validateLocation string: A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.

automatic_tax str: Surfaces if automatic tax computation is possible given the current customer location information.
ip_address str: A recent IP address of the customer used for tax reporting and tax location inference.
locations Sequence[CustomerTaxLocation]: The identified tax location of the customer.
provider str: The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.
validate_location str: A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.

automaticTax String: Surfaces if automatic tax computation is possible given the current customer location information.
ipAddress String: A recent IP address of the customer used for tax reporting and tax location inference.
locations List<Property Map>: The identified tax location of the customer.
provider String: The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.
validateLocation String: A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred.

CustomerTaxIdData, CustomerTaxIdDataArgs

Type string: Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin
Value string: Value of the tax ID.

Type string: Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin
Value string: Value of the tax ID.

type string: Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin
value string: Value of the tax ID.

type String: Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin
value String: Value of the tax ID.

type string: Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin
value string: Value of the tax ID.

type str: Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin
value str: Value of the tax ID.

type String: Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin
value String: Value of the tax ID.

CustomerTaxLocation, CustomerTaxLocationArgs

Country string: The identified tax country of the customer.
Source string: The data source used to infer the customer's location.
State string: The identified tax state, county, province, or region of the customer.

Country string: The identified tax country of the customer.
Source string: The data source used to infer the customer's location.
State string: The identified tax state, county, province, or region of the customer.

country string: The identified tax country of the customer.
source string: The data source used to infer the customer's location.
state string: The identified tax state, county, province, or region of the customer.

country String: The identified tax country of the customer.
source String: The data source used to infer the customer's location.
state String: The identified tax state, county, province, or region of the customer.

country string: The identified tax country of the customer.
source string: The data source used to infer the customer's location.
state string: The identified tax state, county, province, or region of the customer.

country str: The identified tax country of the customer.
source str: The data source used to infer the customer's location.
state str: The identified tax state, county, province, or region of the customer.

country String: The identified tax country of the customer.
source String: The data source used to infer the customer's location.
state String: The identified tax state, county, province, or region of the customer.

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

stripe.Customer

On this page

On this page

Create Customer Resource

Constructor syntax

Parameters

Constructor example

Customer Resource Properties

Inputs

Outputs

Look up Existing Customer Resource

Supporting Types

CustomerAddress, CustomerAddressArgs

CustomerCashBalance, CustomerCashBalanceArgs

CustomerCashBalanceSetting, CustomerCashBalanceSettingArgs

CustomerInvoiceSetting, CustomerInvoiceSettingArgs

CustomerInvoiceSettingCustomField, CustomerInvoiceSettingCustomFieldArgs

CustomerInvoiceSettingRenderingOption, CustomerInvoiceSettingRenderingOptionArgs

CustomerShipping, CustomerShippingArgs

CustomerShippingAddress, CustomerShippingAddressArgs

CustomerTax, CustomerTaxArgs

CustomerTaxIdData, CustomerTaxIdDataArgs

CustomerTaxLocation, CustomerTaxLocationArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

stripe.Customer

On this page

On this page

Create Customer Resource

Constructor syntax

Parameters

Constructor example

Customer Resource Properties

Inputs

Outputs

Look up Existing Customer Resource

Supporting Types

CustomerAddress, CustomerAddressArgs

CustomerCashBalance, CustomerCashBalanceArgs

CustomerCashBalanceSetting, CustomerCashBalanceSettingArgs

CustomerInvoiceSetting, CustomerInvoiceSettingArgs

CustomerInvoiceSettingCustomField, CustomerInvoiceSettingCustomFieldArgs

CustomerInvoiceSettingRenderingOption, CustomerInvoiceSettingRenderingOptionArgs

CustomerShipping, CustomerShippingArgs

CustomerShippingAddress, CustomerShippingAddressArgs

CustomerTax, CustomerTaxArgs

CustomerTaxIdData, CustomerTaxIdDataArgs

CustomerTaxLocation, CustomerTaxLocationArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.