Sign in

Patch API v1 stripe customers by ID

Changed on
patch/api/v1/stripe_customers/{id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

idstring required

ID to identify the stripe user

Example:1

Request body

$schemastring uri

A URL to the JSON Schema for this object.

balanceinteger

Current balance in cents (can be negative)

couponstring

Coupon ID to apply discount

default_sourcestring

ID of default payment source

descriptionstring

Description of customer

emailstring

Customer email

metadataobject

Set of key-value pairs for metadata

namestring

Customer name

phonestring

Customer phone number

preferred_localesstring[] nullable

Customer's preferred languages

promotion_codestring

Promotion code to apply

tax_exemptstring

Tax exemption status: none, exempt, or reverse

Example request

{
  "$schema": "https://example.com/schemas/UpdateStripeCustomerBody.json",
  "email": "newemail@example.com",
  "name": "Jane Doe",
  "phone": "+15555551234",
  "tax_exempt": "none"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

addressstring nullable required

Customer address

balanceinteger required

Customer balance in cents

createdinteger required

Unix timestamp of creation

currencystring nullable required

Default currency

default_sourcestring nullable required

Default payment source ID

delinquentboolean required

Whether customer is delinquent

descriptionstring nullable required

Customer description

emailstring required

Customer email

idstring required

Stripe customer ID

invoice_prefixstring required

Invoice number prefix

livemodeboolean required

Whether in live mode

metadataobject required

Custom metadata

namestring nullable required

Customer name

next_invoice_sequenceinteger required

Next invoice sequence number

objectstring required

Object type

phonestring nullable required

Customer phone number

preferred_localesstring[] nullable required

Preferred locales

shippingstring nullable required

Shipping information

tax_exemptstring required

Tax exempt status

test_clockstring nullable required

Test clock ID

Example response

{
  "$schema": "https://example.com/schemas/GetStripeCustomerResponse.json",
  "created": 1680893993,
  "email": "jennyrosen@example.com",
  "id": "cus_NffrFeUfNV2Hib",
  "invoice_prefix": "0759376C",
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "object": "customer",
  "tax_exempt": "none"
}

Changes