Stripe · JSON Structure

Stripe Customer Structure

The Stripe Customer object representing a business's end customer with stored payment information.

Type: object Properties: 16

CommerceFinancial ServicesFintechPaymentsT1

Customer is a JSON Structure definition published by Stripe, describing 16 properties.

Properties

id object email name phone description balance currency delinquent default_source invoice_settings metadata subscriptions tax_ids created livemode

Meta-schema:

JSON Structure

{
  "name": "Customer",
  "description": "The Stripe Customer object representing a business's end customer with stored payment information.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the customer (prefix: cus_)",
      "example": "cus_NffrFeUfNV2Hib"
    },
    "object": {
      "type": "string",
      "value": "customer"
    },
    "email": {
      "type": "string",
      "description": "Customer's email address",
      "example": "jane@example.com"
    },
    "name": {
      "type": "string",
      "description": "Customer's full name or business name"
    },
    "phone": {
      "type": "string",
      "description": "Customer's phone number"
    },
    "description": {
      "type": "string",
      "description": "Arbitrary string description of the customer"
    },
    "balance": {
      "type": "integer",
      "description": "Current balance in the customer's currency, applied to next invoice"
    },
    "currency": {
      "type": "string",
      "description": "Three-letter ISO 4217 currency code of customer's balance"
    },
    "delinquent": {
      "type": "boolean",
      "description": "Whether the customer is in delinquency on invoices"
    },
    "default_source": {
      "type": "string",
      "description": "ID of the default payment source for the customer"
    },
    "invoice_settings": {
      "type": "object",
      "description": "Default invoice settings for this customer",
      "properties": {
        "default_payment_method": {
          "type": "string",
          "description": "ID of the default payment method for invoices"
        }
      }
    },
    "metadata": {
      "type": "object",
      "description": "Arbitrary key-value metadata"
    },
    "subscriptions": {
      "type": "object",
      "description": "List of subscriptions belonging to the customer"
    },
    "tax_ids": {
      "type": "object",
      "description": "Tax IDs associated with the customer"
    },
    "created": {
      "type": "integer",
      "description": "Unix timestamp when the customer was created"
    },
    "livemode": {
      "type": "boolean",
      "description": "Whether the customer exists in live mode"
    }
  }
}