Sign in

v1

latestSwagger 2.02026-07-1361023.8 KB
v1

Get details for the specified Shopper

<strong>Notes:</strong><ul><li>shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>

get/v1/shoppers/{shopperId}/status

Path parameters

shopperIdstring required

The ID of the shopper to retrieve. Must agree with the shopper id on the token or header, if present

Query parameters

auditClientIpstring required

The client IP of the user who originated the request leading to this call.

Response

Request was successful

billingState'ABANDONED' | 'INACTIVE' | 'ACTIVE'

Indicates the billing state of the Shopper.<br />ABANDONED: The shopper has not been billed in at least 10 years and has no active subscriptions.<br />INACTIVE: The shopper has been billed within the last 10 years but has no active subscriptions.<br />ACTIVE: The shopper has at least one active subscription.