Fetch customer
This endpoint is used to fetch customer details given an identifier. If the Customer
is in the process of being deleted,
only the properties id
and deleted: true
will be returned.
See the Customer resource for a full discussion of the Customer model.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Response
A customer is a buyer of your products, and the other party to the billing relationship.
In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
external_customer_id
with your own identifier. See
Customer ID Aliases for further information about how these
aliases work in Orb.
In addition to having an identifier in your system, a customer may exist in a payment provider solution like
Stripe. Use the payment_provider_id
and the payment_provider
enum field to express this mapping.
A customer also has a timezone (from the standard IANA timezone database), which defaults to your account's timezone. See Timezone localization for information on what this timezone parameter influences within Orb.