PayNow

Account Pages

With a customer token, the Storefront API exposes everything a customer would normally find under "My Account" on the hosted webstore.

All of these calls use the token. None of them need the API key.

Profile

GET /v1/store/customer returns the customer PayNow knows. Their ID, the platform IDs on record, and a profile with display name and avatar URL are returned. Use it for the header and as the sign-in check on every page.

What they currently own

GET /v1/store/customer/delivery/items lists the customer's delivery items. One per product instance they have been granted, whether bought, gifted to them, or assigned from the dashboard.

Each item has a state and timestamps. For an "active items" panel, show items whose state is active or usable and that have no revoked_at or removed_at. expires_at is set for products with an expiry, and is the date to display next to a rank.

This endpoint lists items that were routed to a game server for delivery. An item with no delivery command attached will not appear, even though the customer owns it. See API Behaviour Notes.

Subscriptions

GET /v1/store/customer/subscriptions returns every subscription with its status, billing period, amounts and lines. The fields a subscriptions panel needs:

  • status is active for a subscription that will renew, canceled once it has ended.
  • cancel_at_period_end is true when the customer has cancelled but the current period is still running. Show "ends on" rather than "renews on" for these.
  • current_period_end is the renewal or end date.
  • past_due flags a subscription whose last payment failed and is being retried.
  • total_amount with interval_value and interval_scale give "$9.99 every month".

DELETE /v1/store/customer/subscriptions/{subscriptionId} cancels renewal. The customer keeps what they paid for until current_period_end, and the subscription then ends. Confirm the action in your UI, since there is no undo other than buying again.

Stores using tier groups can also let a subscriber move between tiers with POST /v1/store/tier-groups/{id}/change, previewing the prorated amount first with the /preview variant.

Orders

GET /v1/store/customer/orders returns the customer's orders, newest first, with status, totals, and lines. Each line carries the product name, quantity, and gift with gift_to_customer for gifts. The _str variants of every amount are pre-formatted in the order's currency if you would rather not format minor units yourself.

pretty_id is the short reference to show customers and to ask for in support tickets. Use id for API calls.

Signing out

Clear the cookie holding the customer token. If the customer asks to sign out everywhere, invalidate every token for them from your server with DELETE /v1/stores/{storeId}/customers/{customerId}/tokens.