For the complete documentation index, see llms.txt. This page is also available as Markdown.

PromotionalOffer

A configured promotional offer issued to a specific subscription.

Fields

acceptUrl (String!)

The plain public page URL where an authenticated customer can review and accept the offer.

acceptedAt (ISO8601DateTime)

When acceptance succeeded.

benefit (JSON!)

The benefit saved when this offer was issued.

cancelledAt (ISO8601DateTime)

When the system cancelled the offer.

commitment (JSON)

The optional commitment saved at issuance.

createdAt (ISO8601DateTime!)

When this offer instance was persisted.

definitionRevision (Int!)

The configuration revision saved at issuance.

entryPoint (String!)

The entry point recorded at issuance.

expiresAt (ISO8601DateTime!)

When the offer expires.

id (ID!)

The database ID of the issued offer.

offerDefinition (OfferDefinition!)

The configuration that issued this offer.

rejectedAt (ISO8601DateTime)

When the offer was declined, including choosing another cancellation action.

status (PromotionalOfferStatus!)

Whether the offer is pending, accepted, rejected, or cancelled.

subscriptionId (ID!)

The subscription that received this offer.

viewedAt (ISO8601DateTime)

First recorded view. Historical tracking excludes some portal presentations.

Last updated

Was this helpful?