Get Hedhog updates in your inbox

New releases, fresh recipes, and breaking changes — no spam.

commerce Submodule

customers-access

Customers, subscriptions, entitlements, redemption codes, and authenticated self-service access views.

Source path: libraries/commerce/src/commerce-customers.controller.ts, commerce-subscriptions.controller.ts, commerce-entitlements.controller.ts, commerce-redemption-codes.controller.ts, commerce-profile.controller.ts

Module file: commerce.module.ts

Introduction

This submodule covers the customer side of Commerce after catalog items exist. Customers can hold subscriptions, gain entitlements, redeem codes, and inspect access through profile endpoints.

It also contains the self-service profile surface that authenticated end users use to view orders, active access, and redeem codes without going through the admin CRUD controllers.

HTTP Endpoints

37 endpoints

List customers.

Get one customer.

Params: id (int)

Create a customer.

Update a customer.

Params: id (int)

List subscriptions of one customer.

Params: id (int)

List orders of one customer.

Params: id (int)

List payments of one customer.

Params: id (int)

List entitlements of one customer.

Params: id (int)

List gateway-side customer records.

Params: id (int)

List subscriptions.

Get one subscription.

Params: id (int)

Create a subscription.

Update a subscription.

Params: id (int)

Cancel at period end.

Params: id (int)

Cancel immediately.

Params: id (int)

Reactivate a subscription.

Params: id (int)

List payments tied to a subscription.

Params: id (int)

Get entitlement data for a subscription.

Params: id (int)

List subscription events.

Params: id (int)

List entitlements.

Check entitlement availability/access.

Get one entitlement.

Params: id (int)

Create an entitlement.

Update an entitlement.

Params: id (int)

Revoke an entitlement.

Params: id (int)

Extend an entitlement.

Params: id (int)

List redemption codes.

Get one redemption code.

Params: id (int)

Generate redemption codes.

Revoke a redemption code.

Params: id (int)

Delete a redemption code.

Params: id (int)

Return the current user’s commerce summary.

Return active access/entitlement view for the current user.

List current user orders.

List pending current-user orders.

Self-service subscription cancellation.

Params: id (int)

Redeem a code as the current user.