Read Customer State
Intent
Reads the customer state without changing it.
When to call it
Call this after your application has received or stored the identifier for the customer state.
Access boundary
Authorize the request with a token that carries customers:read or customers:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the customer.
Response
Request completed successfully
- CustomerStateIndividual
- CustomerStateTeam
A customer along with additional state information:
- Active subscriptions
- Granted benefits
- Active meters
Unique identifier for the customer.
"992fae2a-2a17-4b7a-8d9e-e287cf90131b"
The time Ruba created this record.
The time this record last changed.
Email: Email address of the customer. This must be unique within the organization.
"customer@example.com"
Indicates whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.
true
Type: Type of customer.
"individual""individual"
Name assigned to the customer.
"John Doe"
Billing Name: Name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.
"John Doe"
Unique identifier for the organization owning the customer.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Deleted At: Timestamp for when the customer was soft deleted.
"https://www.gravatar.com/avatar/xxx?d=404"
Active Subscriptions: Customer's active subscriptions.
Granted Benefits: Customer's active benefit grants.
Active Meters: Customer's active meters.
Unique identifier for the customer in your system. This must be unique within the organization. Once set, it can't be updated.
"usr_1337"
Unique identifier for the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.