Skip to main content
Deprecated. This page documents the v2 storefront API, which is being retired for external callers. V3 has no documented replacement for this task yet.
A sponsored buyer is a buyer account scoped to your organization’s storefront. The account discovers and transacts only against your inventory and never sees the rest of Apostra. The operator may use that account for one or more advertisers (brand care of operator); the sponsored status gates the account, not an individual advertiser identity.
Shareable buyer invite links are retired. You cannot create a new sponsored buyer through a join link. Direct buyers to your verified storefront or Discovery instead.
In the seller UI, find buyers in Buyers under Your storefront in Storefront: each is an entry in its picker, and a buyer waiting on you shows Awaiting you. This portable Page remains the Account drawer’s and in-chat surface for the sponsored-buyer operations; it is not a standalone navigation destination. Each sponsored buyer carries a status that gates whether it can transact and a seller-selected posture that fixes its billing path. You move status as you onboard, pause, and resume buyers; the buyer cannot override billing.

​
Status lifecycle

A sponsored buyer moves through three states. The status is the transaction gate: only an active buyer can create or edit media buys against your storefront. Allowed transitions:
  • pending → active — Approve a buyer awaiting review.
  • pending or active → suspended — Suspend a buyer to pause new transactions.
  • suspended → active — Reactivate a suspended buyer.
A buyer whose access was revoked stays listed as suspended, but it can no longer be approved, suspended, or reactivated. The list tells you this: each buyer carries availableActions, which is empty for revoked access.
Suspending a buyer blocks new media buys and edits. It does not pause in-flight delivery on media buys that are already running.

​
Key concepts

  • Scope is enforced, not advisory. A sponsored buyer is confined to your storefront at every read and write path — discovery, product details, and media-buy creation. They cannot pin or transact against any other storefront.
  • Billing posture. prepay is consolidated billing (BillingParty=agent); credit is seller direct-billed (BillingParty=operator). The posture is fixed at provisioning time and remains under seller governance.
  • Funding boundaries stay unchanged. prepay uses the existing invoice/deposit media-funding mechanisms and does not automate media funding through the platform-fee card rail. credit does not create an Apostra credit line; the seller invoices the operator directly.
  • Buyer identity. buyerName is the buyer’s company/display name from their account record. It is null when not yet resolvable.

Storefront onboarding

End-to-end seller setup

Errors

Shared error contract