get customer

This block is part of the stripe group and was last modified in core v15.0.0.

get customer v15.0.0

Reads a Stripe customer. A customer deleted in Stripe comes back as a tombstone rather than an error : this block reports that as CUSTOMER_DELETED instead of handing back an almost-empty object that looks live.

In pins 2 + flow
  • flow
    flow
  • connection required
    stripeconnection
  • customer id required
    value
Out pins 12 + flow
  • flow
    flow
  • connection
    stripeconnection
  • customer id
    value

    cus_… : store this on your own user record.

  • email
    value
  • name
    value
  • balance
    number

    Stripe's sign convention is the opposite of the intuitive one: negative is credit the customer holds, positive is what they owe.

  • currency
    value
  • meta data
    object
  • customer
    object
  • success
    condition
  • error
    value

    Stripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.

  • error code
    value

    Stripe's machine-readable code, e.g. card_declined, resource_missing.

  • decline code
    value

    Why the bank refused, e.g. insufficient_funds. Only set on a declined card.

stripe customer
customer balance

The mirror of creating one. The customer_id comes off your own document through get fields, and get customer reads the live record from Stripe. Read it when you need what Stripe knows now, for example the balance or the current email; for anything you display on every page, keep your own copy and refresh it from a webhook rather than calling out on each render.

Studio canvas example for the get customer block: reading a customer back by its stored id.

Version history

Introduced in v15.0.0.

Service documentation

External API reference This block wraps a third-party service. Click here for the service's own documentation of the underlying endpoint.
Back to stripe Return to the main group to view all sub-groups Back to customers Return to the group to view all blocks within this group