Read the Customer Access State

Subscriber Status is a notion that lets you fetch a customer’s current standing, including their active subscriptions and awarded benefits, through a single API call or a single webhook event. Paired with the External ID feature, you can be live in minutes.

​

The subscriber status object

The subscriber status object holds:

• Every detail about the customer.
• The collection of their active subscriptions.
• The collection of their awarded benefits.
• The collection of their active meters, along with their current balance.

So with that one object, you possess everything required to decide whether you should grant access to your service or not.

​

The customer.state_changed webhook

To stay informed about subscriber status updates, you can subscribe to the customer.state_changed webhook event. It fires whenever:

• A customer is created, modified, or removed.
• A subscription is created or modified.
• A benefit is granted or withdrawn.

By subscribing to this webhook event, you keep your system current and adjust your customer’s access accordingly.