Stripe

Manage Stripe customers, products, prices, subscriptions, and more.

Resources

Customer

Create and manage Stripe customers.

import { Customer } from "alchemy/stripe";

const customer = await Customer("basic-customer", {
  email: "john@example.com",
  name: "John Doe",
  description: "Premium customer",
  metadata: {
    tier: "premium",
    source: "website"
  }
});

import { Customer } from "alchemy/stripe";

const customer = await Customer("customer-with-address", {
  email: "jane@example.com",
  name: "Jane Smith",
  phone: "+1-555-123-4567",
  address: {
    line1: "123 Main St",
    line2: "Apt 4B",
    city: "San Francisco",
    state: "CA",
    postalCode: "94105",
    country: "US"
  },
  shipping: {
    name: "Jane Smith",
    address: {
      line1: "456 Oak Ave",
      city: "Oakland",
      state: "CA",
      postalCode: "94612",
      country: "US"
    }
  }
});

import { Customer } from "alchemy/stripe";

const customer = await Customer("business-customer", {
  email: "billing@acmecorp.com",
  name: "Acme Corporation",
  description: "Enterprise customer",
  taxExempt: "exempt",
  invoicePrefix: "ACME",
  preferredLocales: ["en"],
  metadata: {
    type: "business",
    industry: "technology",
    employees: "500+"
  }
});

Props

string

Customer’s email address

string

The customer’s full name or business name

string

An arbitrary string attached to the object

string

The customer’s phone number

object

The customer’s address

Show child attributes

string

Address line 1 (e.g., street, PO Box, or company name)

string

Address line 2 (e.g., apartment, suite, unit, or building)

string

City, district, suburb, town, or village

string

State, county, province, or region

string

ZIP or postal code

string

Two-letter country code (ISO 3166-1 alpha-2)

object

The customer’s shipping information

Show child attributes

string

Customer name

string

Customer phone number

object

Customer’s shipping address (same structure as address)

Record<string, string>

Set of key-value pairs that you can attach to an object

number

An integer amount in cents that represents the customer’s current balance

string

The prefix for the customer used to generate unique invoice numbers

string[]

Customer’s preferred languages, ordered by preference

'exempt' | 'none' | 'reverse'

The customer’s tax exemption status

object

Default invoice settings for this customer

Show child attributes

array

Default custom fields to be displayed on invoices

string

ID of a payment method that’s attached to the customer

string

Default footer to be displayed on invoices

string

The ID of the PaymentMethod to attach to the customer

Secret

API key to use (overrides environment variable)

boolean

If true, adopt existing resource if creation fails due to conflict

Returns

string

The ID of the customer

'customer'

String representing the object’s type

string

Customer’s email address

string

The customer’s full name or business name

number

Time at which the object was created

boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode

string

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

string

ID of the default payment source for the customer

boolean

Whether or not the customer is currently delinquent

object

The customer’s address

object

The customer’s shipping information

object

Set of key-value pairs attached to the object

Core API

Cloudflare

AWS

Databases

Services

Utilities

Stripe

Stripe

Resources

Customer

Props

Returns

​Stripe

​Resources

​Customer

​Props

​Returns

Stripe

Resources

Customer

Props

Returns